diff options
Diffstat (limited to 'data/en_us/arms/2019-08-08')
| -rw-r--r-- | data/en_us/arms/2019-08-08/api-docs.php | 70732 |
1 files changed, 29118 insertions, 41614 deletions
diff --git a/data/en_us/arms/2019-08-08/api-docs.php b/data/en_us/arms/2019-08-08/api-docs.php index ae52d48..88e4fe0 100644 --- a/data/en_us/arms/2019-08-08/api-docs.php +++ b/data/en_us/arms/2019-08-08/api-docs.php @@ -1,357 +1,63 @@ <?php return [ 'version' => '1.0', - 'info' => [ - 'style' => 'V3', - 'product' => 'ARMS', - 'version' => '2019-08-08', - ], + 'info' => ['style' => 'RPC', 'product' => 'ARMS', 'version' => '2019-08-08'], 'directories' => [ [ - 'id' => 170580, - 'title' => 'Monitoring Metrics', + 'children' => ['GetTraceApp', 'QueryAppTopology', 'GetStack', 'GetTraceAppConfig', 'GetAgentDownloadUrlV2', 'GetAgentDownloadUrl', 'QueryAppMetadata', 'DeleteAppList'], 'type' => 'directory', - 'children' => [ - 'QueryMetricByPage', - ], + 'title' => 'Application Monitoring', ], [ - 'id' => 128346, - 'title' => 'Application Monitoring', + 'children' => ['GetRumUploadFiles', 'CreateRumUploadFileUrl', 'DeleteRumUploadFile', 'GetRumAppInfo', 'UpdateRumApp', 'GetRumExceptionStack'], 'type' => 'directory', - 'children' => [ - 'GetTraceApp', - 'GetAppJVMConfig', - 'QueryAppTopology', - 'GetAppApiByPage', - 'GetTrace', - 'GetStack', - 'GetMultipleTrace', - 'ConfigApp', - 'SaveTraceAppConfig', - 'GetTraceAppConfig', - 'DeleteTraceApp', - 'QueryReleaseMetric', - 'ListTraceApps', - 'SearchTraceAppByName', - 'SearchTraceAppByPage', - 'SearchTraces', - 'SearchTracesByPage', - 'GetAgentDownloadUrlV2', - 'GetAgentDownloadUrl', - 'DescribeTraceLicenseKey', - 'ListInsightsEvents', - 'QueryAppMetadata', - 'DeleteAppList', - 'DoInsightsAction', - ], - ], - [ - 'id' => 128359, - 'title' => 'Browser Monitoring', - 'type' => 'directory', - 'children' => [ - 'Upload', - 'DeleteSourceMap', - 'GetSourceMapInfo', - 'CreateRetcodeApp', - 'GetRetcodeShareUrl', - 'DeleteRetcodeApp', - 'SetRetcodeShareStatus', - 'ListRetcodeApps', - 'SearchRetcodeAppByPage', - 'GetRetcodeLogstore', - 'GetRetcodeDataByQuery', - 'GetRetcodeAppByPid', - ], - ], - [ - 'id' => 191976, 'title' => 'User Experience Monitoring', - 'type' => 'directory', - 'children' => [ - 'UpdateRumFileStatus', - 'GetRumUploadFiles', - 'GetRumDataForPage', - 'CreateRumUploadFileUrl', - 'DeleteRumUploadFile', - 'GetRumAppInfo', - 'GetRumApps', - 'CreateRumApp', - 'DeleteRumApp', - 'UpdateRumApp', - 'GetRumExceptionStack', - ], ], [ - 'id' => 128367, - 'title' => 'Managed Service for Prometheus', + 'children' => ['DescribeEnvDropMetricsRule', 'UpdateEnvDropMetricsRule', 'CreateEnvPodMonitor', 'DescribeAddonRelease', 'ListAddonReleases', 'GetIntegrationState', 'DeleteCmsExporter', 'ListCmsInstances', 'InstallManagedPrometheus', 'GetPrometheusInstance', 'CreatePrometheusInstance', 'ListEnvironmentAddons'], 'type' => 'directory', - 'children' => [ - 'DescribeEnvDropMetricsRule', - 'UpdateEnvDropMetricsRule', - 'AddTagToFlinkCluster', - 'CreateEnvironment', - 'InitEnvironment', - 'DescribeEnvironment', - 'UpdateEnvironment', - 'ListEnvironments', - 'DeleteEnvironment', - 'DescribeAddonMetrics', - 'InstallEnvironmentFeature', - 'DescribeEnvironmentFeature', - 'UpgradeEnvironmentFeature', - 'RestartEnvironmentFeature', - 'ListEnvironmentFeatures', - 'DeleteEnvironmentFeature', - 'CreateEnvCustomJob', - 'UpdateEnvCustomJob', - 'ListEnvCustomJobs', - 'DescribeEnvCustomJob', - 'DeleteEnvCustomJob', - 'CreateEnvPodMonitor', - 'DescribeEnvPodMonitor', - 'ListEnvPodMonitors', - 'UpdateEnvPodMonitor', - 'DeleteEnvPodMonitor', - 'CreateEnvServiceMonitor', - 'DescribeEnvServiceMonitor', - 'ListEnvServiceMonitors', - 'UpdateEnvServiceMonitor', - 'DeleteEnvServiceMonitor', - 'InstallAddon', - 'DescribeAddonRelease', - 'ListAddons', - 'UpgradeAddonRelease', - 'ListAddonReleases', - 'DeleteAddonRelease', - 'ListEnvironmentDashboards', - 'EnableMetric', - 'UpdateMetricDrop', - 'UpdatePrometheusMonitoringStatus', - 'UpdatePrometheusMonitoring', - 'ListPrometheusMonitoring', - 'GetPrometheusMonitoring', - 'DeletePrometheusMonitoring', - 'CreatePrometheusMonitoring', - 'AppendInstancesToPrometheusGlobalView', - 'AddPrometheusInstance', - 'AddPrometheusGlobalViewByAliClusterIds', - 'AddPrometheusGlobalView', - 'AddAliClusterIdsToPrometheusGlobalView', - 'AddRecordingRule', - 'SyncRecordingRules', - 'AddIntegration', - 'GetIntegrationState', - 'DeleteIntegration', - 'AddGrafana', - 'InstallCmsExporter', - 'OpenVCluster', - 'DeletePrometheusGlobalView', - 'RemoveAliClusterIdsFromPrometheusGlobalView', - 'RemoveSourcesFromPrometheusGlobalView', - 'DeleteCmsExporter', - 'DelAuthToken', - 'DeleteGrafanaResource', - 'UninstallPromCluster', - 'QueryPromInstallStatus', - 'ListPrometheusGlobalView', - 'GetPrometheusGlobalView', - 'CheckServiceStatus', - 'GetPrometheusApiToken', - 'GetExploreUrl', - 'ListDashboards', - 'ListClusterFromGrafana', - 'GetRecordingRule', - 'ListCmsInstances', - 'ListDashboardsByName', - 'GetAuthToken', - 'GetClusterAllUrl', - 'GetCloudClusterAllUrl', - 'ListPrometheusInstances', - 'InstallManagedPrometheus', - 'UninstallManagedPrometheus', - 'GetManagedPrometheusStatus', - 'BindPrometheusGrafanaInstance', - 'AddPrometheusIntegration', - 'UpdatePrometheusIntegration', - 'DeletePrometheusIntegration', - 'GetPrometheusIntegration', - 'ListPrometheusIntegration', - 'GetPrometheusInstance', - 'ListPrometheusInstanceByTagAndResourceGroupId', - 'CreatePrometheusInstance', - 'UpdatePrometheusInstance', - 'UpdatePrometheusGlobalView', - 'ListEnvironmentKubeResources', - 'ListEnvironmentMetricTargets', - 'ListEnvironmentAddons', - 'ListEnvironmentAlertRules', - ], - ], - [ - 'id' => 186945, - 'title' => 'Managed Service for Grafana', - 'type' => 'directory', - 'children' => [ - 'ListGrafanaWorkspace', - 'GetGrafanaWorkspace', - 'CreateGrafanaWorkspace', - 'UpdateGrafanaWorkspace', - 'UpdateGrafanaWorkspaceVersion', - 'DeleteGrafanaWorkspace', - ], + 'title' => 'Managed Service for Prometheus', ], [ - 'id' => 128330, - 'title' => 'Business Monitoring', + 'children' => ['CreateGrafanaWorkspace'], 'type' => 'directory', - 'children' => [ - 'ApplyScenario', - 'DeleteScenario', - 'ListScenario', - ], + 'title' => 'Managed Service for Grafana', ], [ - 'id' => 184789, - 'title' => 'Synthetic Monitoring (New)', + 'children' => ['UpdateTimingSyntheticTask', 'StartTimingSyntheticTask', 'GetTimingSyntheticTask', 'ListSyntheticDetail'], 'type' => 'directory', - 'children' => [ - 'CreateTimingSyntheticTask', - 'UpdateTimingSyntheticTask', - 'StopTimingSyntheticTask', - 'StartTimingSyntheticTask', - 'DeleteTimingSyntheticTask', - 'GetSyntheticMonitors', - 'ListTimingSyntheticTasks', - 'GetTimingSyntheticTask', - 'ListSyntheticDetail', - ], + 'title' => 'Synthetic Monitoring (New)', ], [ - 'id' => 169864, - 'title' => 'Synthetic Monitoring (Old)', + 'children' => ['CreateOrUpdateAlertRule', 'GetAlertRules', 'GetOnCallSchedulesDetail'], 'type' => 'directory', - 'children' => [ - 'CreateSyntheticTask', - 'GetSyntheticTaskMonitors', - 'SwitchSyntheticTaskStatus', - 'GetSyntheticTaskList', - 'GetSyntheticTaskDetail', - 'DeleteSyntheticTask', - ], + 'title' => 'Alert Management', ], [ - 'id' => 128391, - 'title' => 'Alert Management', + 'children' => ['UpdatePrometheusAlertRule'], 'type' => 'directory', - 'children' => [ - 'CreateIntegration', - 'UpdateIntegration', - 'DeleteIntegrations', - 'ListIntegration', - 'CreateOrUpdateAlertRule', - 'DeleteAlertRule', - 'ListAlertEvents', - 'GetAlertRules', - 'CreateOrUpdateContact', - 'SendTTSVerifyLink', - 'DeleteContact', - 'DescribeContacts', - 'CreateOrUpdateContactGroup', - 'DeleteContactGroup', - 'DescribeContactGroups', - 'CreateOrUpdateIMRobot', - 'DeleteIMRobot', - 'DescribeIMRobots', - 'CreateOrUpdateWebhookContact', - 'DeleteWebhookContact', - 'DescribeWebhookContacts', - 'CreateOrUpdateEventBridgeIntegration', - 'DeleteEventBridgeIntegration', - 'ListEventBridgeIntegrations', - 'CreateOrUpdateNotificationPolicy', - 'DeleteNotificationPolicy', - 'ListNotificationPolicies', - 'CreateOrUpdateSilencePolicy', - 'DeleteSilencePolicy', - 'ListEscalationPolicies', - 'ListOnCallSchedules', - 'GetOnCallSchedulesDetail', - 'ListSilencePolicies', - 'ListAlerts', - 'BlockAlarmNotification', - 'ChangeAlarmSeverity', - 'CloseAlarm', - 'ClaimAlarm', - ], - ], - [ - 'id' => 128334, 'title' => 'Prometheus Alerts (Outdated)', - 'type' => 'directory', - 'children' => [ - 'CreatePrometheusAlertRule', - 'DeletePrometheusAlertRule', - 'UpdatePrometheusAlertRule', - 'DescribePrometheusAlertRule', - 'ListPrometheusAlertRules', - 'ListPrometheusAlertTemplates', - ], ], [ - 'id' => 128374, - 'title' => 'Alerts (Outdated)', - 'type' => 'directory', - 'children' => [ - 'CreateAlertContact', - 'CreateWebhook', - 'CreateAlertContactGroup', - 'CreateDispatchRule', - 'ListActivatedAlerts', - 'ImportAppAlertRules', - 'DeleteAlertRules', - 'DeleteAlertContact', - 'DeleteAlertContactGroup', - 'DeleteDispatchRule', - 'UpdateWebhook', - 'UpdateAlertContact', - 'UpdateAlertContactGroup', - 'UpdateAlertRule', - 'StartAlert', - 'StopAlert', - 'UpdateDispatchRule', - 'SearchAlertRules', - 'SearchAlertContact', - 'SearchAlertContactGroup', - 'SearchAlertHistories', - 'SearchEvents', - 'DescribeDispatchRule', - 'ListDispatchRule', - ], - ], - [ - 'id' => 128327, - 'title' => 'Service Activation', + 'children' => ['QueryCommercialUsage'], 'type' => 'directory', - 'children' => [ - 'OpenArmsServiceSecondVersion', - 'OpenXtraceDefaultSLR', - 'OpenArmsDefaultSLR', - 'ChangeResourceGroup', - 'TagResources', - 'UntagResources', - ], + 'title' => 'Billing', ], [ - 'id' => 187814, - 'title' => 'Billing', - 'type' => 'directory', 'children' => [ - 'GetCommercialStatus', - 'CheckCommercialStatus', - 'QueryCommercialUsage', - 'GetRumOcuStatisticData', - ], + 'AddAliClusterIdsToPrometheusGlobalView', 'AddGrafana', 'AddIntegration', 'AddPrometheusGlobalView', 'AddPrometheusGlobalViewByAliClusterIds', 'AddPrometheusInstance', 'AddPrometheusIntegration', 'AddRecordingRule', 'AddTagToFlinkCluster', 'AppendInstancesToPrometheusGlobalView', 'ApplyScenario', 'BindPrometheusGrafanaInstance', 'BlockAlarmNotification', 'ChangeAlarmSeverity', 'ChangeResourceGroup', 'CheckCommercialStatus', 'CheckServiceStatus', 'ClaimAlarm', 'CloseAlarm', 'ConfigApp', + 'CreateAlertContact', 'CreateAlertContactGroup', 'CreateDispatchRule', 'CreateEnvCustomJob', 'CreateEnvServiceMonitor', 'CreateEnvironment', 'CreateIntegration', 'CreateOrUpdateContact', 'CreateOrUpdateContactGroup', 'CreateOrUpdateEventBridgeIntegration', 'CreateOrUpdateIMRobot', 'CreateOrUpdateNotificationPolicy', 'CreateOrUpdateSilencePolicy', 'CreateOrUpdateWebhookContact', 'CreatePrometheusAlertRule', 'CreatePrometheusMonitoring', 'CreateRetcodeApp', 'CreateRumApp', 'CreateSyntheticTask', 'CreateTimingSyntheticTask', + 'CreateWebhook', 'DelAuthToken', 'DeleteAddonRelease', 'DeleteAlertContact', 'DeleteAlertContactGroup', 'DeleteAlertRule', 'DeleteAlertRules', 'DeleteContact', 'DeleteContactGroup', 'DeleteDispatchRule', 'DeleteEnvCustomJob', 'DeleteEnvPodMonitor', 'DeleteEnvServiceMonitor', 'DeleteEnvironment', 'DeleteEnvironmentFeature', 'DeleteEventBridgeIntegration', 'DeleteGrafanaResource', 'DeleteGrafanaWorkspace', 'DeleteIMRobot', 'DeleteIntegration', + 'DeleteIntegrations', 'DeleteNotificationPolicy', 'DeletePrometheusAlertRule', 'DeletePrometheusGlobalView', 'DeletePrometheusIntegration', 'DeletePrometheusMonitoring', 'DeleteRetcodeApp', 'DeleteRumApp', 'DeleteScenario', 'DeleteSilencePolicy', 'DeleteSourceMap', 'DeleteSyntheticTask', 'DeleteTimingSyntheticTask', 'DeleteTraceApp', 'DeleteWebhookContact', 'DescribeAddonMetrics', 'DescribeContactGroups', 'DescribeContacts', 'DescribeDispatchRule', 'DescribeEnvCustomJob', + 'DescribeEnvPodMonitor', 'DescribeEnvServiceMonitor', 'DescribeEnvironment', 'DescribeEnvironmentFeature', 'DescribeIMRobots', 'DescribePrometheusAlertRule', 'DescribeTraceLicenseKey', 'DescribeWebhookContacts', 'DoInsightsAction', 'EnableMetric', 'GetAppApiByPage', 'GetAppJVMConfig', 'GetAuthToken', 'GetCloudClusterAllUrl', 'GetClusterAllUrl', 'GetCommercialStatus', 'GetExploreUrl', 'GetGrafanaWorkspace', 'GetManagedPrometheusStatus', 'GetMultipleTrace', + 'GetPrometheusApiToken', 'GetPrometheusGlobalView', 'GetPrometheusIntegration', 'GetPrometheusMonitoring', 'GetRecordingRule', 'GetRetcodeAppByPid', 'GetRetcodeDataByQuery', 'GetRetcodeLogstore', 'GetRetcodeShareUrl', 'GetRumApps', 'GetRumDataForPage', 'GetRumOcuStatisticData', 'GetSourceMapInfo', 'GetSyntheticMonitors', 'GetSyntheticTaskDetail', 'GetSyntheticTaskList', 'GetSyntheticTaskMonitors', 'GetTrace', 'ImportAppAlertRules', 'InitEnvironment', + 'InstallAddon', 'InstallCmsExporter', 'InstallEnvironmentFeature', 'ListActivatedAlerts', 'ListAddons', 'ListAlertEvents', 'ListAlerts', 'ListClusterFromGrafana', 'ListDashboards', 'ListDashboardsByName', 'ListDispatchRule', 'ListEnvCustomJobs', 'ListEnvPodMonitors', 'ListEnvServiceMonitors', 'ListEnvironmentAlertRules', 'ListEnvironmentDashboards', 'ListEnvironmentFeatures', 'ListEnvironmentKubeResources', 'ListEnvironmentMetricTargets', 'ListEnvironments', + 'ListEscalationPolicies', 'ListEventBridgeIntegrations', 'ListGrafanaWorkspace', 'ListInsightsEvents', 'ListIntegration', 'ListNotificationPolicies', 'ListOnCallSchedules', 'ListPrometheusAlertRules', 'ListPrometheusAlertTemplates', 'ListPrometheusGlobalView', 'ListPrometheusInstanceByTagAndResourceGroupId', 'ListPrometheusInstances', 'ListPrometheusIntegration', 'ListPrometheusMonitoring', 'ListRetcodeApps', 'ListScenario', 'ListSilencePolicies', 'ListTimingSyntheticTasks', 'ListTraceApps', 'OpenArmsDefaultSLR', + 'OpenArmsServiceSecondVersion', 'OpenVCluster', 'OpenXtraceDefaultSLR', 'QueryMetricByPage', 'QueryPromInstallStatus', 'QueryReleaseMetric', 'RemoveAliClusterIdsFromPrometheusGlobalView', 'RemoveSourcesFromPrometheusGlobalView', 'RestartEnvironmentFeature', 'SaveTraceAppConfig', 'SearchAlertContact', 'SearchAlertContactGroup', 'SearchAlertHistories', 'SearchAlertRules', 'SearchEvents', 'SearchRetcodeAppByPage', 'SearchTraceAppByName', 'SearchTraceAppByPage', 'SearchTraces', 'SearchTracesByPage', + 'SendTTSVerifyLink', 'SetRetcodeShareStatus', 'StartAlert', 'StopAlert', 'StopTimingSyntheticTask', 'SwitchSyntheticTaskStatus', 'SyncRecordingRules', 'TagResources', 'UninstallManagedPrometheus', 'UninstallPromCluster', 'UntagResources', 'UpdateAlertContact', 'UpdateAlertContactGroup', 'UpdateAlertRule', 'UpdateDispatchRule', 'UpdateEnvCustomJob', 'UpdateEnvPodMonitor', 'UpdateEnvServiceMonitor', 'UpdateEnvironment', 'UpdateGrafanaWorkspace', + 'UpdateGrafanaWorkspaceVersion', 'UpdateIntegration', 'UpdateMetricDrop', 'UpdatePrometheusGlobalView', 'UpdatePrometheusInstance', 'UpdatePrometheusIntegration', 'UpdatePrometheusMonitoring', 'UpdatePrometheusMonitoringStatus', 'UpdateRumFileStatus', 'UpdateWebhook', 'UpgradeAddonRelease', 'UpgradeEnvironmentFeature', 'Upload', + ], + 'title' => 'Others', + 'type' => 'directory', ], ], 'components' => [ @@ -359,11 +65,10 @@ 'GrafanaWorkspace' => [ 'title' => 'grafana', 'description' => 'The information about the Grafana workspace.'."\n", - 'visibility' => 'public', 'type' => 'object', 'properties' => [ 'status' => [ - 'title' => '', + 'title' => '状态', 'description' => 'The status of the workspace.'."\n" ."\n" .'Valid values:'."\n" @@ -379,29 +84,15 @@ .'- Running：The workspace is running'."\n" ."\n" .'- DeleteSucceed：The workspace is deleted', - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'StartFailed' => '', - 'Stop' => '', - 'Starting' => '', - 'DeleteFailed' => '', - 'Running' => '', - 'DeleteSucceed' => '', - ], + 'enumValueTitles' => ['StartFailed' => '启动失败', 'Stop' => '停机', 'Starting' => '启动中', 'DeleteFailed' => '释放失败', 'Running' => '运行中', 'DeleteSucceed' => '释放成功'], 'example' => 'Starting、Running、Stop、DeleteSucceed', + 'visibility' => 'Public', 'backendName' => 'status', ], - 'description' => [ - 'title' => '', - 'description' => 'The description.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Grafana for Production ', - 'backendName' => 'description', - ], + 'description' => ['title' => '描述', 'description' => 'The description.'."\n", 'type' => 'string', 'example' => '线上生产环境Grafana', 'visibility' => 'Public', 'backendName' => 'description'], 'grafanaWorkspaceEdition' => [ - 'title' => '', + 'title' => '版本', 'description' => 'The version.'."\n" ."\n" .'Valid values:'."\n" @@ -412,98 +103,31 @@ .'- experts_edition：Expert Edition'."\n" ."\n" .'- advanced_edition：Advanced Edition', - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - 'standard' => '', - 'personal_edition' => '', - 'experts_edition' => '', - 'advanced_edition' => '', - ], + 'enumValueTitles' => ['standard' => '内测版', 'personal_edition' => '开发者版', 'experts_edition' => '专家版', 'advanced_edition' => '高级版'], 'example' => 'personal_edition、experts_edition、advanced_edition、standard', + 'visibility' => 'Public', 'backendName' => 'instanceEdition', ], - 'endTime' => [ - 'title' => '', - 'description' => 'The time when the workspace expires.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'float', - 'example' => '1652803200000', - 'backendName' => 'endTime', - ], - 'grafanaWorkspaceId' => [ - 'title' => '', - 'description' => 'The ID of the workspace.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'grafana-cn-4xl3g******', - 'backendName' => 'instanceId', - ], + 'endTime' => ['title' => '到期时间', 'description' => 'The time when the workspace expires.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1652803200000', 'visibility' => 'Public', 'backendName' => 'endTime'], + 'grafanaWorkspaceId' => ['title' => '工作区Id', 'description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'example' => 'grafana-cn-4xl3g******', 'visibility' => 'Public', 'backendName' => 'instanceId'], 'upgradeVersion' => [ - 'title' => '', + 'title' => '可升级的版本', 'description' => 'The versions that are available for upgrades.'."\n", - 'visibility' => 'public', 'type' => 'array', - 'items' => [ - 'description' => 'The version to which you want to upgrade.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '9.0.x', - 'extendType' => 'true', - ], - 'backendName' => 'upgradeVersion', - ], - 'grafanaWorkspaceIp' => [ - 'title' => '', - 'description' => 'The public IP address and port number.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '47.110.71.***:443', - 'backendName' => 'instanceIp', - ], - 'snatIp' => [ - 'title' => '', - 'description' => 'The outbound IP address.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '47.110.71.***', - 'backendName' => 'snatIp', - ], - 'grafanaWorkspaceDomain' => [ - 'title' => '', - 'description' => 'The domain name of the workspace.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'my-grafana.grafana.aliyuncs.com:443', - 'backendName' => 'instanceDomain', - ], - 'grafanaWorkspaceDomainStatus' => [ - 'title' => '工作区域名状态', - 'description' => 'status of workspace domain', + 'items' => ['description' => 'The version to which you want to upgrade.'."\n", 'type' => 'string', 'example' => '9.0.x', 'visibility' => 'Public', 'extendType' => 'true', 'title' => ''], 'visibility' => 'Public', - 'type' => 'string', - 'example' => 'on', - 'backendName' => 'instanceDomainStatus', - ], - 'commercial' => [ - 'title' => '', - 'description' => 'Indicates whether the workspace is commercialized.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'commercial', - ], - 'grafanaWorkspaceName' => [ - 'title' => '', - 'description' => 'The workspace name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'Grafana for Production', - 'backendName' => 'instanceName', + 'backendName' => 'upgradeVersion', + 'example' => '', ], + 'grafanaWorkspaceIp' => ['title' => '公网ip带端口', 'description' => 'The public IP address and port number.'."\n", 'type' => 'string', 'example' => '47.110.71.***:443', 'visibility' => 'Public', 'backendName' => 'instanceIp'], + 'snatIp' => ['title' => '出口IP', 'description' => 'The outbound IP address.'."\n", 'type' => 'string', 'example' => '47.110.71.***', 'visibility' => 'Public', 'backendName' => 'snatIp'], + 'grafanaWorkspaceDomain' => ['title' => '工作区域名', 'description' => 'The domain name of the workspace.'."\n", 'type' => 'string', 'example' => 'my-grafana.grafana.aliyuncs.com:443', 'visibility' => 'Public', 'backendName' => 'instanceDomain'], + 'grafanaWorkspaceDomainStatus' => ['title' => '工作区域名状态', 'description' => 'status of workspace domain', 'type' => 'string', 'example' => 'on', 'visibility' => 'Public', 'backendName' => 'instanceDomainStatus'], + 'commercial' => ['title' => '是否商业化', 'description' => 'Indicates whether the workspace is commercialized.'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'commercial'], + 'grafanaWorkspaceName' => ['title' => '工作区名称', 'description' => 'The workspace name.'."\n", 'type' => 'string', 'example' => '线上生产环境Grafana', 'visibility' => 'Public', 'backendName' => 'instanceName'], 'grafanaVersion' => [ - 'title' => '', + 'title' => '对应的Grafana版本', 'description' => 'The version number of Grafana.'."\n" ."\n" .'Valid values:'."\n" @@ -531,742 +155,306 @@ .' <!-- -->'."\n" ."\n" .' <!-- -->'."\n", - 'visibility' => 'public', 'type' => 'string', - 'enumValueTitles' => [ - '8.2.x' => '8.2.x', - '10.0.x' => '10.0.x', - '9.0.x' => '9.0.x', - ], + 'enumValueTitles' => ['8.2.x' => '8.2.x', '10.0.x' => '10.0.x', '9.0.x' => '9.0.x'], 'example' => '9.0.x', + 'visibility' => 'Public', 'backendName' => 'grafanaVersion', ], - 'gmtCreate' => [ - 'title' => '1642079398000', - 'description' => 'The time when the workspace was created.'."\n", - 'visibility' => 'public', - 'type' => 'number', - 'format' => 'float', - 'example' => '1642079398000', - 'backendName' => 'gmtCreate', - ], - 'userId' => [ - 'title' => '', - 'description' => 'The user ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '1412143830******', - 'backendName' => 'userId', - ], - 'maxAccount' => [ - 'title' => '', - 'description' => 'The maximum number of accounts.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '10', - 'backendName' => 'maxAccount', - ], - 'regionId' => [ - 'title' => '', - 'description' => 'The region ID of the disk.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'cn-hangzhou', - 'backendName' => 'regionId', - ], - 'protocol' => [ - 'title' => '', - 'description' => 'The protocol type.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'http、https', - 'backendName' => 'protocol', - ], - 'shareSynced' => [ - 'title' => '', - 'description' => 'Indicates whether the migration guide for the shared edition is provided.'."\n", - 'visibility' => 'public', - 'type' => 'boolean', - 'example' => 'true', - 'backendName' => 'shareSynced', - ], - 'ntmId' => [ - 'title' => '', - 'description' => 'The ID of the purchase order.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'grafana-cn-4xl3g******', - 'backendName' => 'ntmId', - ], - 'personalDomain' => [ - 'title' => '', - 'description' => 'The personalized domain name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'my-grafana.grafana.aliyuncs.com:443', - 'backendName' => 'personalDomain', - ], - 'personalDomainPrefix' => [ - 'title' => '', - 'description' => 'The prefix of the personalized domain name.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'my-grafana', - 'backendName' => 'personalDomainPrefix', - ], - 'resourceGroupId' => [ - 'title' => '', - 'description' => 'The resource group ID.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'rg-aek2f4vzrfs6cla', - 'backendName' => 'resourceGroupId', - ], - 'deployType' => [ - 'title' => '', - 'description' => 'The deployment mode of Grafana. You can ignore this parameter.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'asi', - 'backendName' => 'deployType', - ], + 'gmtCreate' => ['title' => '1642079398000', 'description' => 'The time when the workspace was created.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '1642079398000', 'visibility' => 'Public', 'backendName' => 'gmtCreate'], + 'userId' => ['title' => '用户id', 'description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '1412143830******', 'visibility' => 'Public', 'backendName' => 'userId'], + 'maxAccount' => ['title' => '最大账号数量', 'description' => 'The maximum number of accounts.'."\n", 'type' => 'string', 'example' => '10', 'visibility' => 'Public', 'backendName' => 'maxAccount'], + 'regionId' => ['title' => '地域ID', 'description' => 'The region ID of the disk.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'visibility' => 'Public', 'backendName' => 'regionId'], + 'protocol' => ['title' => '协议', 'description' => 'The protocol type.'."\n", 'type' => 'string', 'example' => 'http、https', 'visibility' => 'Public', 'backendName' => 'protocol'], + 'shareSynced' => ['title' => '是否有过共享版迁移引导', 'description' => 'Indicates whether the migration guide for the shared edition is provided.'."\n", 'type' => 'boolean', 'example' => 'true', 'visibility' => 'Public', 'backendName' => 'shareSynced'], + 'ntmId' => ['title' => '实例id', 'description' => 'The ID of the purchase order.'."\n", 'type' => 'string', 'example' => 'grafana-cn-4xl3g******', 'visibility' => 'Public', 'backendName' => 'ntmId'], + 'personalDomain' => ['title' => '个性化域名', 'description' => 'The personalized domain name.'."\n", 'type' => 'string', 'example' => 'my-grafana.grafana.aliyuncs.com:443', 'visibility' => 'Public', 'backendName' => 'personalDomain'], + 'personalDomainPrefix' => ['title' => '个性化域名前缀', 'description' => 'The prefix of the personalized domain name.'."\n", 'type' => 'string', 'example' => 'my-grafana', 'visibility' => 'Public', 'backendName' => 'personalDomainPrefix'], + 'resourceGroupId' => ['title' => '资源组id', 'description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-aek2f4vzrfs6cla', 'visibility' => 'Public', 'backendName' => 'resourceGroupId'], + 'deployType' => ['title' => '部署模式', 'description' => 'The deployment mode of Grafana. You can ignore this parameter.'."\n", 'type' => 'string', 'example' => 'asi', 'visibility' => 'Public', 'backendName' => 'deployType'], 'tags' => [ - 'title' => '', + 'title' => '标签', 'description' => 'The tags.'."\n", - 'visibility' => 'public', 'type' => 'array', 'items' => [ 'description' => '', - 'visibility' => 'public', 'type' => 'object', 'properties' => [ - 'key' => [ - 'title' => '', - 'description' => 'The tag key.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'TestKey', - 'backendName' => 'key', - ], - 'value' => [ - 'title' => '', - 'description' => 'The tag value.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'TestValue', - 'backendName' => 'value', - ], + 'key' => ['title' => '键', 'description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'visibility' => 'Public', 'backendName' => 'key'], + 'value' => ['title' => '值', 'description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'visibility' => 'Public', 'backendName' => 'value'], ], + 'visibility' => 'Public', 'extendType' => 'true', + 'title' => '', + 'example' => '', ], + 'visibility' => 'Public', 'backendName' => 'tags', + 'example' => '', ], - 'privateIp' => [ - 'title' => '', - 'description' => 'The private IP address and port number.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => '192.168.1.1'."\n", - 'backendName' => 'privateIp', - ], - 'privateDomain' => [ - 'title' => '', - 'description' => 'The private domain name of the workspace.'."\n", - 'visibility' => 'public', - 'type' => 'string', - 'example' => 'my-grafana.grafana.aliyuncs.com:80', - 'backendName' => 'privateDomain', - ], + 'privateIp' => ['title' => '私网ip带端口', 'description' => 'The private IP address and port number.'."\n", 'type' => 'string', 'example' => '192.168.1.1'."\n", 'visibility' => 'Public', 'backendName' => 'privateIp'], + 'privateDomain' => ['title' => '私网工作区域名', 'description' => 'The private domain name of the workspace.'."\n", 'type' => 'string', 'example' => 'my-grafana.grafana.aliyuncs.com:80', 'visibility' => 'Public', 'backendName' => 'privateDomain'], ], + 'visibility' => 'Public', + 'example' => '', ], ], ], 'apis' => [ - 'QueryMetricByPage' => [ - 'summary' => 'Queries an Application Monitoring metric or a Browser Monitoring metric.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddAliClusterIdsToPrometheusGlobalView' => [ + 'summary' => 'Adds a global aggregation instance as a data source in Managed Service for Prometheus.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'IntervalInSec', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time interval at which you want to query metric data. Unit: milliseconds. Minimum value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '100000', - 'default' => '2147483647', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775806', - 'minimum' => '0', - 'example' => '1667287695000', - ], + 'schema' => ['description' => 'The name of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'GlobalViewClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775806', - 'minimum' => '0', - 'example' => '1667546895000', - ], + 'schema' => ['description' => 'The ID of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', 'title' => ''], ], [ - 'name' => 'OrderBy', + 'name' => 'ClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The dimension for arranging metrics in sequence. For more information, see the supplementary metrics.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pid', - ], + 'schema' => ['description' => 'The IDs of clusters. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', 'title' => ''], ], - [ - 'name' => 'Metric', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The metric that you want to query. You cannot specify a custom metric. For more information, see the "Application monitoring metrics that can be queried" section.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'appstat.host', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Msg' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Info' => ['description' => 'The Info-level information.'."\n", 'type' => 'string', 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', 'title' => ''], + 'Code' => ['description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'AddAliClusterIdsToPrometheusGlobalView', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAliClusterIdsToPrometheusGlobalView'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}\\"\\n },\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'AddGrafana' => [ + 'summary' => 'Integrates the dashboard of Managed Service for Prometheus.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which measures are sorted. Valid values:'."\n" - ."\n" - .'* `ASC`: ascending order'."\n" - .'* `DESC`: descending order'."\n" - ."\n" - .'> If you do not specify the parameter, data is not sorted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'CurrentPage', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is no longer supported. The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'Filters', + 'name' => 'Integration', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'asm', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The filter conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the array object.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the filter condition. You must set the key to `pid` or `regionId`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pid', - ], - 'Value' => [ - 'description' => 'The value of the filter condition. You must set the value of the `pid` or `regionId` condition. For information about how to obtain the `pid`, see the "Obtain the PID of an application" section.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxx@74xxx', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', 'title' => ''], ], - 'required' => false, - 'maxItems' => 15, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddGrafanaResponse>\\n\\t<RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n\\t<Data>success</Data>\\n</AddGrafanaResponse>","errorExample":""}]', + 'title' => 'AddGrafana', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-04T06:58:14.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddGrafana'], + ], + ], + ], + 'AddIntegration' => [ + 'summary' => 'Integrates the dashboard and collection rules of Prometheus Service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Dimensions', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The dimensions of the metric that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The dimensions of the metric that you want to query. For more information, see the "Application monitoring metrics that can be queried" section. You can specify a maximum of five dimensions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pid', - ], - 'required' => false, - 'example' => '["detector_browser","detector_device"]', - 'maxItems' => 15, - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Measures', + 'name' => 'ClusterId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The measures of the metric that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The measures of the metric that you want to query. For more information, see the "Application monitoring metrics that can be queried" section. You can specify a maximum of five measures.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'instanceCount', - ], - 'required' => false, - 'example' => 'pv', - 'maxItems' => 15, - ], + 'schema' => ['description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'CustomFilters', + 'name' => 'Integration', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'Custom filter conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Custom filter conditions. Separate multiple filter conditions with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["not rpcType:40","not rpcType:41"]', - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'asm', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* 2XX: The request was successful.'."\n" - .'* 3XX: A redirection message was returned.'."\n" - .'* 4XX: The request was invalid.'."\n" - .'* 5XX: A server error occurred.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the call fails.'."\n", - 'type' => 'string', - 'example' => 'StartTime is mandatory for this action.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '687F9CB7-4798-57BF-A6EE-E6CC76******', - ], - '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', - ], - 'Data' => [ - 'description' => 'The information about the array object.'."\n", - 'type' => 'object', - 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Page' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Completed' => [ - 'description' => 'Whether the paging query ends.'."\n" - ."\n" - .'true: end.'."\n" - .'false: Need to continue pagination (continue to query after CurrentPage+1).', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Items' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'object', - 'example' => '[]', - ], - ], - ], - ], + 'Data' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The prompt information of the returned result.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMetricIllegal', - 'errorMessage' => 'The specified metric is invalid.', - ], - [ - 'errorCode' => 'ParameterMeasuresIllegal', - 'errorMessage' => 'The specified Measures is invalid.', - ], - [ - 'errorCode' => 'ParameterTimeStampIllegal', - 'errorMessage' => 'The specified timeStamp is invalid.', - ], - [ - 'errorCode' => 'ParameterOrderIllegal', - 'errorMessage' => 'The specified order is invalid.', - ], - [ - 'errorCode' => 'ParameterZeroStrategyIllegal', - 'errorMessage' => 'The specified zeroStrategy is invalid.', - ], - [ - 'errorCode' => 'ParameterPageSizeIllegal', - 'errorMessage' => 'The specified PageSize is invalid.', - ], - [ - 'errorCode' => 'ParameterIntervalIllegal', - 'errorMessage' => 'The specified interval is invalid.', - ], - [ - 'errorCode' => 'ParameterMeasuresMissing', - 'errorMessage' => 'You must specify measures.', - ], - [ - 'errorCode' => 'ParameterDimensionsIllegal', - 'errorMessage' => 'The specified dimensions is invalid.', - ], - [ - 'errorCode' => 'ParameterPidMissing', - 'errorMessage' => 'You must specify pid.', - ], - [ - 'errorCode' => 'ParameterRegionIdIllegal', - 'errorMessage' => 'The specified RegionId is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => 'The specified region is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', - ], - ], - [ - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The application does not exist.', - ], - [ - 'errorCode' => 'RunningTaskNotExist', - 'errorMessage' => 'Application data collection task does not exist or has been stopped.', - ], - ], - 429 => [ - [ - 'errorCode' => 'OperationIsThrottled', - 'errorMessage' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.', - ], - ], - 452 => [ - [ - 'errorCode' => 'OperationTimeOut', - 'errorMessage' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.', - ], - ], + 'staticInfo' => [ + 'substitutions' => ['ARMS::2019-08-08::InstallAddon'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"StartTime is mandatory for this action.\\",\\n \\"RequestId\\": \\"687F9CB7-4798-57BF-A6EE-E6CC76******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 1,\\n \\"Total\\": 2,\\n \\"Page\\": 1,\\n \\"Completed\\": false,\\n \\"Items\\": [\\n []\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryMetricByPageResponse>\\n <Code>200</Code>\\n <Message>StartTime is mandatory for this action.</Message>\\n <RequestId>626037F5-FDEB-45B0-804C-B3C92797****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageSize>10</PageSize>\\n <Total>0</Total>\\n <Page>1</Page>\\n <Items/>\\n </Data>\\n</QueryMetricByPageResponse>","errorExample":""}]', - 'title' => 'QueryMetricByPage', - 'requestParamsDescription' => '## Obtain the PID of an application'."\n" - ."\n" - .'In the left-side navigation pane of the ARMS console, choose **Application Monitoring > Application List** or **Browser Monitoring > Browser Monitoring**. On the Application List or Browser Monitoring page, click the name of the application that you want to view.'."\n" - ."\n" - .'The URL in the address bar contains the **process ID (PID)** of the application. The PID is indicated in the `pid=xxx` format. The PID is usually percent encoded as `xxx%40xxx`. You must modify this value to remove the percent encoding. For example, if the PID in the URL is `eb4zdose6v%409781be0f44d****`, you must replace `%40` with an at sign (`@`) to obtain `eb4zdose6v@9781be0f44d****`.'."\n" - ."\n" - .'## Application Monitoring metrics supporting query'."\n" - ."\n" - .'**Note** You must set the **pid** and `regionId` filter conditions by specifying the `Filters` parameter. You must set all known filter conditions by specifying the **Filters** parameter to define the range of query results. If no filter conditions are known, you can specify one or more **dimensions** provided in the following table to narrow down the query range.'."\n" - ."\n" - .'|Metric|Description|Dimension|Measurement|'."\n" - .'|---|---|---|---|'."\n" - .'|appstat.vm|A collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.|\\- pid\\- rootIp|GC metrics:\\- youngGcCount: the number of GCs in the young generation\\- oldGcCount: the number of full heap GCs (full GCs)\\- youngGcTime: the amount of time consumed by GCs in the young generation\\- oldGcTime: the amount of time consumed by full GCs\\- youngGcCountInstant: the instantaneous value of the number of GCs in the young generation\\- oldGcCountInstant: the instantaneous value of the number of full GCs\\- youngGcTimeInstant: the instantaneous value of the amount of time consumed by GCs in the young generation\\- oldGcTimeInstant: the instantaneous value of the amount of time consumed by full GCs|'."\n" - .'|appstat.vm|A collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to garbage collections (GCs), heap memory, non-heap memory, and threads.|\\- pid\\- rootIp|Heap memory and non-heap memory:\\- edenSpace: the eden space in the young generation\\- oldGen: the old generation\\- survivorSpace: the survivor space in the young generation\\- metaSpace: the metaspace\\- nonHeapCommitted: the non-heap memory\\- nonHeapInit: the initial value of the non-heap memory\\- nonHeapMax: the maximum value of the non-heap memory\\- nonHeapUsed: the usage of the non-heap memory\\- directUsed: the amount of used direct buffer in the off-heap memory\\- directCapacity: the total amount of direct buffer in the off-heap memory|'."\n" - .'|appstat.vm|A collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.|\\- pid\\- rootIp|Number of threads:\\- threadCount: the total number of threads\\- threadNewCount: the number of new threads\\- threadDeadlockCount: the number of deadlocked threads in the JVM\\- threadRunnableCount: the number of runnable threads in the JVM\\- threadTerminatedCount: the number of terminated threads\\- threadTimedWaitCount: the number of threads in the timed\\_waiting state\\- threadWaitCount: the number of threads in the waiting state\\- threadBlockedCount: the number of blocked threads|'."\n" - .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|instanceCount: the number of instances|'."\n" - .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|CPU:\\- systemCpuIdle: the percentage of idle CPU in the last 5 seconds, which is not displayed in the ARMS console\\- systemCpuSystem: the CPU utilization of the system in the last 5 seconds\\- systemCpuUser: the percentage of CPU occupied by users in the last 5 seconds\\- systemCpuIoWait: the percentage of CPU consumed for I/O waiting in the last 5 seconds|'."\n" - .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|Physical memory:\\- systemMemFree: the amount of free memory (Unit: KB)\\- systemMemUsed: the amount of used memory (Unit: KB)\\- systemMemTotal: the total amount of memory, which is not displayed in the ARMS console (Unit: KB)\\- systemMemBuffers: the amount of memory in the buffer cache\\- systemMemCached: the amount of memory in the page cache|'."\n" - .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|Disk:\\- systemDiskFree: the size of free disk space in bytes\\- systemDiskUsedRatio: the usage of the disk space\\- SystemDiskTotal: the total size of disk space in bytes, which is not displayed in the ARMS console|'."\n" - .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|systemLoad: the load|'."\n" - .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|Network:\\- systemNetInPackets: the average number of packets received over the network per second in the last 30 seconds\\- systemNetOutPackets: the average number of packets sent over the network per second in the last 30 seconds\\- systemNetInErrs: the average number of frame errors received over the network per second in the last 30 seconds\\- systemNetOutErrs: the average number of errors sent over the network per second in the last 30 seconds\\- systemNetInBytes: the average number of bytes received over the network per second in the last 30 seconds\\- systemNetOutBytes: the average number of bytes sent over the network per second in the last 30 seconds|'."\n" - .'|appstat.database|A collection of metrics for database calls.|\\- pid\\- rpcType: the type of the call\\- endpoint: the database endpoint, which is localhost: 3306\\- destId: the database name, which is arms|\\- rt: the response time (Unit: milliseconds).\\- count: the number of requests.\\- error: the number of errors.\\- resultsize: This metric is available only for MySQL 5.x.\\- slowcount: the number of slow calls.|'."\n" - .'|appstat.incall|A collection of metrics related to application details.|\\- pid\\- rpcType\\- rootIp\\- rpc\\- ppid|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: the number of errors\\- errorrate: the error rate\\- qps: the number of queries per second|'."\n" - .'|appstat.exception|A collection of metrics related to exceptions.|\\- pid\\- rpc\\- endpoint\\- excepType\\- excepInfo|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: the number of errors|'."\n" - .'|appstat.sql|A collection of metrics related to slow SQL queries.|\\- pid\\- rpc\\- endpoint\\- sqlId|\\- rt: the response time (Unit: milliseconds).\\- count: the number of requests.\\- error: the number of errors.\\- slowcount: the number of slow calls.\\- resultsize: This metric is available only for MySQL 5.x.Note: If the value of the slow metric is true, the filter conditions do not take effect.|'."\n" - .'|appstat.mq.send|A collection of metrics related to message sending by using a message queue.|None|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: error: the number of errors\\- delay: the scheduling delay (Unit: milliseconds)|'."\n" - .'|appstat.mq.receive|A collection of metrics related to message receiving by using a message queue.|None|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: error: the number of errors\\- delay: the scheduling delay (Unit: milliseconds)|'."\n" - .'|appstat.schedulerx|A collection of metrics related to SchedulerX calls.|\\- pid\\- rpcType\\- rootIp\\- rpc|count: the number of requests|'."\n" - .'|appstat.elasticsearch|A collection of metrics related to Elasticsearch calls.|\\- rpc\\- endpoint\\- opType: the type of the operation, such as index and search operations. This dimension is supported only when elasticsearch-rest-high-level-client is used.|count: the number of requests|'."\n" - .'|appstat.redis|A collection of metrics related to ApsaraDB for Redis calls.|\\- pid\\- rpcType\\- endpoint\\- opType\\- rpc|count: the number of requests|'."\n" - .'|appstat.status|The number of requests with specified status codes. Only HTTP requests are supported.|\\- pid\\- rootIp\\- rpc|\\- 200: the number of requests with the 200 status code (abnormal)\\- 2xx: the number of requests with 2XX status codes (abnormal)\\- 3xx: the number of requests with 3XX status codes\\- 4xx: the number of requests with 4XX status codes (client errors)\\- 5xx: the number of requests with 5XX status codes (server errors)|'."\n" - ."\n" - .'## Browser Monitoring metrics supporting query'."\n" - ."\n" - .'You can call the QueryMetric operation to query the following metrics of Browser Monitoring.'."\n" - ."\n" - .'**Note** You must set the **pid** and `regionId` filter conditions by specifying the `Filters` parameter. You must set all known filter conditions by specifying the **Filters** parameter to define the range of query results. If no filter conditions are known, you can specify one or more **dimensions** provided in the following table to narrow down the query range.'."\n" - ."\n" - .'|Metric|Description|Dimension|Measurement|'."\n" - .'|---|---|---|---|'."\n" - .'|webstat.api|Success rate of API requests|\\- api: the URL of the API without request parameters\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution|\\- count: the number of requests\\- rate: the success rate of API requests\\- avg\\_time: the average response time|'."\n" - .'|webstat.api.detail|API details|\\- api: the URL of the API without request parameters\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_browser\\_version: the version of the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- detector\\_os\\_version: the version of the operating system\\- domain: the domain name\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- msg: the returned message\\- page: the URL of the page\\- sr: the screen resolution|\\- count: the number of requests\\- fail\\_count: the number of failed API requests\\- fail\\_time: the response time for failed API requests\\- fail\\_uv: the number of users affected by failures\\- success\\_count: the number of successful API requests\\- success\\_rate: the success rate\\- success\\_time: the response time for successful API requests|'."\n" - .'|webstat.apicost|Response time for successful API requests|\\- api: the URL of the API without request parameters\\- code: the returned status code\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution|\\- count: the number of successful API requests\\- avg\\_time: the average response time for successful API requests|'."\n" - .'|webstat.apifailtime|Response time for failed API requests|\\- api: the URL of the API without request parameters\\- code: the returned status code\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution|\\- count: the number of failed API requests\\- avg\\_time: the average response time for failed API requests|'."\n" - .'|webstat.apimsg|Classification and aggregation of API response messages|\\- code: the returned status code\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- msg: the error message\\- release: the version number\\- sr: the screen resolution\\- success: The value 1 indicates that the request is successful and the value 0 indicates that the request has failed.|count: the number of requests|'."\n" - .'|webstat.avg|Custom statistics: average|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- key: the custom key\\- sr: the screen resolution|\\- count: the total number of occurrences\\- pv: the number of page views\\- uv: the number of unique visitors\\- avg\\_val: the average value|'."\n" - .'|webstat.errcate|Error message ranking|\\- msg: the error message\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- sr: the screen resolution\\- release: the version number\\- environment: the environment\\- detector\\_app\\_version: the client version\\- detector\\_app: the client app|count: the number of errors|'."\n" - .'|webstat.index|Page view overview|\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- pv: the number of page views\\- uv: the number of unique visitors|'."\n" - .'|webstat.msg.top|Frequent errors|\\- msg: the error message\\- page: the URL of the page|\\- count: the number of errors\\- error\\_uv: the number of affected users\\- Ratio of affected users: the ratio obtained by dividing affected users by total UVs|'."\n" - .'|webstat.perf.bucket|Performance Sample Distribution section on the **Page Speed** page in the ARMS console|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- cfpt: the custom first paint time (FPT) of the page\\- ctti: the custom time to interact (TTI) of the page\\- dns: the amount of time consumed by DNS query\\- dom: the amount of time consumed by DOM parsing\\- fmp: the first meaningful paint (FMP) of the page\\- fpt: the FPT of the page\\- load: the amount of time consumed to completely load the page\\- ready: the time taken for the DOM to become ready\\- res: the amount of time consumed to load resources\\- ssl: the amount of time consumed to establish a Secure Sockets Layer (SSL) connection\\- t1\\\\~t10: the custom performance metrics\\- tcp: the amount of time consumed to establish a Transmission Control Protocol (TCP) connection\\- trans: the amount of time consumed to transfer the content of the page\\- ttfb: the time to first byte (TTFB)\\- tti: the TTI of the page|'."\n" - .'|webstat.perf.distribution|Performance Stacked Area Chart on the **Page Speed** page in the ARMS console|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- cfpt: the custom FPT of the page\\- ctti: the custom TTI of the page\\- dns: the amount of time consumed by DNS query\\- dom: the amount of time consumed by DOM parsing\\- fmp: the FMP of the page\\- fpt: the FPT of the page\\- load: the amount of time consumed to completely load the page\\- ready: the time taken for the DOM to become ready\\- res: the amount of time consumed to load resources\\- ssl: the amount of time consumed to establish an SSL connection\\- t1\\\\~t10: the custom performance metrics\\- tcp: the amount of time consumed to establish a TCP connection\\- trans: the amount of time consumed to transfer the content of the page\\- ttfb: the TTFB\\- tti: the TTI of the page|'."\n" - .'|webstat.resource|Resource error ranking|\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- node\\_name: the error type\\- page: the URL of the page\\- sr: the screen resolution\\- src: the resource information|count: the number of resource errors|'."\n" - .'|webstat.resource|Resource Error section on the **Overview** page in the ARMS console|\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- node\\_name: the error type\\- page: the URL of the page\\- sr: the screen resolution\\- src: the resource information|count: the number of errors|'."\n" - .'|webstat.satisfy|Satisfaction|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- bad: frustrated, indicating that the FPT is greater than 8,000\\- good: satisfied, indicating that the FPT is smaller than 2,000\\- neutral: tolerable, indicating that the FPT is between 2,000 and 8,000\\- satisfy: Application Performance Index (Apdex)|'."\n" - .'|webstat.session|Slow loading tracking|None|\\- browser\\_version: the browser version\\- browser: the browser\\- date: the start time of the data query\\- dom: the amount of time consumed by DOM parsing\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_country: the name of the country or area\\- ip\\_region\\_id: the ID of the region\\- ip\\_region: the name of the region\\- load: the amount of time consumed to completely load the page\\- page: the URL of the page\\- sid: the session ID|'."\n" - .'|webstat.speed|Access speed|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution\\- page: the URL of the page\\- environment: the environment|\\- avg\\_cfpt: the custom FPT of the page\\- count: the number of samples\\- avg\\_ctti: the custom TTI of the page\\- avg\\_dns: the amount of time consumed by DNS query\\- avg\\_dom: the amount of time consumed by DOM parsing\\- avg\\_fmp: the FMP of the page\\- avg\\_fpt: the FPT of the page\\- avg\\_load: the amount of time consumed to completely load the page\\- avg\\_ready: the average time taken for the DOM to become ready\\- avg\\_res: the amount of time consumed to load resources\\- avg\\_ssl: the amount of time consumed to establish an SSL connection\\- avg\\_t1\\\\~t10: the custom performance metrics\\- avg\\_tcp: the amount of time consumed to establish a TCP connection\\- avg\\_trans: the amount of time consumed to transfer the content of the page\\- avg\\_ttfb: the TTFB\\- avg\\_tti: the TTI of the page|'."\n" - .'|webstat.stable|Error rate ranking|\\- page: the URL of the page\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- sr: the screen resolution\\- msg: the error message\\- release: the version number\\- environment: the environment\\- detector\\_app\\_version: the client version\\- detector\\_app: the client app|\\- count: the number of samples\\- error\\_pv: the number of JS errors\\- rate: the JS error rate|'."\n" - .'|webstat.sum|Custom statistics: sum|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- key: the custom key\\- sr: the screen resolution|\\- count: the total number of occurrences of specified events\\- pv: the number of page views\\- sum\\_val: the total value\\- uv: the number of unique visitors|'."\n" - .'|webstat.url|Access URL|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- sr: the screen resolution\\- uid\\- username: the username|\\- pv: the number of page views\\- uv: the number of unique visitors|', - 'responseParamsDescription' => '**Sample response**'."\n" - ."\n" - .' {'."\n" - .' "RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",'."\n" - .' "Data": {'."\n" - .' "PageSize": 1,'."\n" - .' "Total": 87,'."\n" - .' "Page": 1,'."\n" - .' "Items": ['."\n" - .' {'."\n" - .' "date": 1667287680000,'."\n" - .' "instanceCount": 17,'."\n" - .' "rule": "query1",'."\n" - .' "pid": "null"'."\n" - .' },'."\n" - .' {'."\n" - .' "date": 1667290680000,'."\n" - .' "instanceCount": 17,'."\n" - .' "rule": "query1",'."\n" - .' "pid": "null"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "Code": 200,'."\n" - .' "Success": true'."\n" - .' }'."\n", - 'extraInfo' => '## Browser Monitoring FAQ'."\n" - ."\n" - .'* Why does an error about the RAM permissions occur when I call the API? This is because the RAM user does not have required permissions. You can grant the permissions to the RAM user. For more information, see [Use a RAM role to access resources across Alibaba Cloud accounts](~~74785~~).'."\n" - ."\n" - .'* How do I obtain a list of data entries without specifying a time interval? Set the intervalInSec parameter to 2147483647.'."\n" - ."\n" - .'* Why is 0 returned for all the queries?'."\n" - ."\n" - .' * Check whether the time interval that you set is too short. Make sure that the value of the intervalInSec parameter is greater than or equal to 60,000.'."\n" - ."\n" - .' * Check whether the value of the regionId parameter is valid. The value depends on the region where the server that receives logs resides, rather than the region where you reside. You can identify the region ID based on the URL of the log source.'."\n" - ."\n" - .' * URL of the log source in the China (Hangzhou) region: `https://arms-retcode.aliyuncs.com/r.png?`'."\n" - .' * URL of the log source in the Singapore region: `https://arms-retcode-sg.aliyuncs.com/r.png?`'."\n" - .' * URL of the log source in the US (Silicon Valley) region: `https://retcode-us-west-1.arms.aliyuncs.com/r.png?`'."\n" - ."\n" - .'* Why does an error occur when I call the simulator or an API?'."\n" - ."\n" - .' * Check whether the regionId parameter is specified and whether the pid parameter is specified by using the Filters parameter.'."\n" - .' * Check whether you have specified a valid value of the Measures or Dimensions parameter for the metric. For more information, see the **Browser Monitoring metrics that can be queried** section in this topic.'."\n" - ."\n" - .'* Error messages and solutions'."\n" - ."\n" - .' * **Query error. Contact the administrator.**'."\n" - ."\n" - .' * Check whether the value of the Metric parameter is valid.'."\n" - .' * Check whether the value of the Measures or Dimensions parameter is valid.'."\n" - .' * Check whether the pid parameter is specified by using the Filters parameter.'."\n" - ."\n" - .' * **InvalidIntervalInSec** Check whether the value of the intervalInSec parameter exceeds the maximum value 2,147,483,647.'."\n" - ."\n" - .' * **MissingMeasures** Check whether the Measures parameter is specified.'."\n" - ."\n" - .' * **NonsequenceParameter.Dimensions**'."\n" - ."\n" - .' * Check whether the value of the Dimensions parameter is valid.'."\n" - .' * Check whether the value of the Dimensions parameter contains extra spaces.'."\n" - ."\n" - .' * **ServiceUnavailable** Check whether the value of the regionId parameter is valid.'."\n" - ."\n" - .' * **Invalid Region** Check whether the value of the regionId parameter is valid. The value depends on the region where the server that receives logs resides, rather than the region where you reside. You can identify the region ID based on the URL of the log source.'."\n" - ."\n" - .' * URL of the log source in the China (Hangzhou) region: `https://arms-retcode.aliyuncs.com/r.png?`'."\n" - .' * URL of the log source in the Singapore region: `https://arms-retcode-sg.aliyuncs.com/r.png?`'."\n" - .' * URL of the log source in the US (Silicon Valley) region: `https://retcode-us-west-1.arms.aliyuncs.com/r.png?`'."\n" - ."\n" - .'* Why are some Measures or Dimensions parameters missing from my dataset? This happens because you can specify a maximum of five Measures or Dimensions parameters. If more than five parameters are specified, no data can be returned.'."\n" - ."\n" - .'* Why does the sum of some metrics significantly decrease after they are aggregated compared with when they were not aggregated? For example, when the values of the pv parameter for the webstat.index metric are aggregated, the sum of aggregated values is significantly less than the sum of all the individual values. The API gateway admits a maximum of 10,000 data entries at a time. Additional data entries are discarded. When you attempt to aggregate more than 10,000 data entries, only the first 10,000 data entries are aggregated and the rest are discarded. This causes the aggregated result to be far less than the result of individually adding all the values. You must make sure that no more than 10,000 data entries are returned for each request. This ensures that you can obtain an accurate aggregated value.'."\n", - ], - 'GetTraceApp' => [ - 'summary' => 'Queries the details of an application monitoring task.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIntegrationResponse>\\n\\t<RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n\\t<Data>success</Data>\\n</AddIntegrationResponse>","errorExample":""}]', + 'title' => 'AddIntegration', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-23T02:17:42.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIntegration'], + ], ], + 'ramActions' => [], + ], + 'AddPrometheusGlobalView' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application. For more information about how to obtain the PID, see [Obtain the PID of an application](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b590lhguqs@d8deedfa9bf****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the aggregation instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'Clusters', + 'in' => 'query', + 'schema' => ['description' => 'The list of aggregation instances. The value is a JSON string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ { "sourceName": "数据源名称- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId", }, { "sourceName": "数据源名称 - MetrcStore No.2", "sourceType":"MetricStore", "dataSource":"MetricStore的 remote read 地址", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"自建Prometheus数据源 remoteread地址", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"其他数据源如Tencent remoteread地址", "headers":{ "AnyHeaderToFill":"需要填充的Headers" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-aek2eq4pecazwfy', 'title' => ''], + ], + [ + 'name' => 'Tag', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of tags.'."\n", + 'description' => 'The list of tags.', 'type' => 'array', 'items' => [ - 'description' => 'The list of tags.'."\n", + 'description' => 'The tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'http.status_code', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], @@ -1275,1333 +463,479 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', - ], - 'TraceApp' => [ - 'description' => 'The information about the array object.'."\n", + 'Data' => [ + 'description' => 'The response struct.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'* `TRACE`: Application Monitoring'."\n" - .'* `RETCODE`: Browser Monitoring'."\n", - 'type' => 'string', - 'example' => 'TRACE', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'arms-k8s-demo', - ], - 'UpdateTime' => [ - 'description' => 'The timestamp generated when the task information was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1635700348000', - ], - 'Show' => [ - 'description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'description' => 'The timestamp generated when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1576599253000', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'b590lhguqs@d8deedfa9bf****', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Labels' => [ - 'description' => 'The aliases of the application.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags of the application.'."\n", - 'type' => 'string', - 'example' => '[ "test", "123123123", "uat" ],', - ], - ], - 'Tags' => [ - 'description' => 'A list of key-value pairs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - ], + 'Success' => ['description' => 'Indicates whether the query was successful.'."\n" + ."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Msg' => ['description' => 'The additional description.', 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Info' => [ + 'description' => 'The Info-level information.', + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'GlobalViewClusterId' => ['description' => 'The aggregation instance ID.', 'type' => 'string', 'example' => 'global-v2-cn-1483223059272121-jmjjfznz', 'title' => ''], + 'FailedInstances' => ['description' => 'The list of instances that failed to be added.', 'type' => 'string', 'example' => '[{"sourceName": "数据源名称- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]', 'title' => ''], ], - ], - 'Source' => [ - 'description' => 'The source of the application.'."\n", - 'type' => 'string', - 'example' => 'ACSK8S', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], - 'ClusterId' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'c905d1364c2dd4b6284a3f41790c4****', - ], - 'Language' => [ - 'description' => 'The programming language of the application.'."\n", - 'type' => 'string', - 'example' => 'java', + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源JSON list中，添加失败的单个JSON的list}', + 'title' => '', ], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D80ADAAC-8C32-5479-BD14-C28CF832****\\",\\n \\"TraceApp\\": {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"arms-k8s-demo\\",\\n \\"UpdateTime\\": 1635700348000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1576599253000,\\n \\"Pid\\": \\"b590lhguqs@d8deedfa9bf****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"[ \\\\\\"test\\\\\\", \\\\\\"123123123\\\\\\", \\\\\\"uat\\\\\\" ],\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Source\\": \\"ACSK8S\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"ClusterId\\": \\"c905d1364c2dd4b6284a3f41790c4****\\",\\n \\"Language\\": \\"java\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTraceAppResponse>\\n <RequestId>D80ADAAC-8C32-5479-BD14-C28CF832****</RequestId>\\n <TraceApp>\\n <Type>TRACE</Type>\\n <AppId>123</AppId>\\n <UserId>113197164949****</UserId>\\n <CreateTime>1576599253000</CreateTime>\\n <UpdateTime>1635700348000</UpdateTime>\\n <Pid>b590lhguqs@d8deedfa9bfxxxx</Pid>\\n <Show>true</Show>\\n <Labels>test</Labels>\\n <Labels>123123123</Labels>\\n <Labels>uat</Labels>\\n <RegionId>cn-hangzhou</RegionId>\\n <AppName>arms-k8s-demo</AppName>\\n </TraceApp>\\n</GetTraceAppResponse>","errorExample":""}]', - 'title' => 'GetTraceApp', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetAppJVMConfig' => [ - 'summary' => 'Obtain the JVM configuration information of each instance of the application', - 'methods' => [ - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'Create aggregation instance', + 'summary' => 'Adds an aggregation instance for ARMS Prometheus monitoring.', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-29T06:37:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-27T13:01:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusGlobalView'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalViewClusterId\\": \\"global-v2-cn-1483223059272121-jmjjfznz\\",\\n \\"FailedInstances\\": \\"[{\\\\\\"sourceName\\\\\\": \\\\\\"数据源名称- ArmsPrometheus\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"UserID\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"ClusterId\\\\\\",}]\\"\\n }\\n },\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'AddPrometheusGlobalViewByAliClusterIds' => [ + 'summary' => 'Adds a global aggregation instance in Managed Service for Prometheus.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDof the application.'."\n" - .' '."\n" - .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Application Monitoring** > **Applications**. On the **Applications** page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.', - 'type' => 'string', - 'required' => false, - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], + 'schema' => ['description' => 'The name of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'ProductCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1480521600000', - ], + 'schema' => ['description' => 'The identifier to identify the service if custom dashboards are created for the specified clusters.'."\n", 'type' => 'string', 'required' => false, 'example' => 'adcp', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ClusterIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1480607940000', - ], + 'schema' => ['description' => 'The IDs of clusters. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Code' => [ - 'description' => 'The response code. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'JvmInfoList' => [ - 'description' => 'The list of JVM information.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Pid' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'dsv9zcel92@1455182510c5369', - ], - 'VmArgs' => [ - 'description' => 'The VM parameters.'."\n", - 'type' => 'string', - 'example' => '[-javaagent:/home/admin/.opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar, -Doneagent.plugin.arms-agent.enabled=true, -Darms.licenseKey=[******], -Darms.agent.env=K8s, -Darms.agent.podinfo.path=/etc/podinfo, -Darms.appName=productservice, -Doneagent.region=cn-hangzhou, -Dproject.name=Product]', - ], - 'HostName' => [ - 'description' => 'The hostname.'."\n", - 'type' => 'string', - 'example' => 'host_name', - ], - 'Ip' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '47.91.59.244', - ], - 'AgentVersion' => [ - 'description' => 'The version of the agent.'."\n", - 'type' => 'string', - 'example' => '1.7.0-SNAPSHOT_3.0.3_3756244', - ], - 'ProcId' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], + 'Data' => [ + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Msg' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Info' => ['description' => 'The Info-level information.'."\n", 'type' => 'string', 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9', 'title' => ''], + 'Code' => ['description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"JvmInfoList\\": [\\n {\\n \\"Pid\\": \\"dsv9zcel92@1455182510c5369\\",\\n \\"VmArgs\\": \\"[-javaagent:/home/admin/.opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar, -Doneagent.plugin.arms-agent.enabled=true, -Darms.licenseKey=[******], -Darms.agent.env=K8s, -Darms.agent.podinfo.path=/etc/podinfo, -Darms.appName=productservice, -Doneagent.region=cn-hangzhou, -Dproject.name=Product]\\",\\n \\"HostName\\": \\"host_name\\",\\n \\"Ip\\": \\"47.91.59.244\\",\\n \\"AgentVersion\\": \\"1.7.0-SNAPSHOT_3.0.3_3756244\\",\\n \\"ProcId\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetAppJVMConfig', - ], - 'QueryAppTopology' => [ - 'summary' => 'Queries the topology of an application.', - 'methods' => [ - 'post', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'AddPrometheusGlobalViewByAliClusterIds', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusGlobalViewByAliClusterIds'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"success\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}\\"\\n },\\n \\"RequestId\\": \\"3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'AddPrometheusInstance' => [ + 'summary' => 'Creates a Prometheus instance for Remote Write.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n" - ."\n" - .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], - ], - [ - 'name' => 'AppType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application type', - 'type' => 'string', - 'required' => false, - 'example' => 'TRACE', - ], + 'schema' => ['description' => 'The name of the Prometheus instance for Remote Write.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'notificationpolicy_test', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The type kind of topology.', - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'apm_txn' => '', - 'apm_app_v2' => '', - 'apm_database_v2' => '', - 'apm_apps' => '', - 'apm_app' => '', - 'apm_txn_v2' => '', - 'apm_database' => '', - 'apm_apps_v2' => '', - ], - 'example' => 'apm_apps_v2', - ], - ], - [ - 'name' => 'Rpc', - 'in' => 'query', - 'schema' => [ - 'description' => 'RPC interface name.', - 'type' => 'string', - 'required' => false, - 'example' => '/eventCenter', - ], - ], - [ - 'name' => 'Db', - 'in' => 'query', - 'schema' => [ - 'description' => 'The database domain name.', - 'type' => 'string', - 'required' => false, - 'example' => 'rm-xxx.mysql.rds.aliyuncs.com:3306', - ], - ], - [ - 'name' => 'DbName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the database.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'orders', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1595568910000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1671952708499', - ], - ], - [ - 'name' => 'Filters', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The filter conditions.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The filter conditions.'."\n", - 'example' => '"rootIp":"127.0.0.1"', - ], - ], + 'schema' => ['description' => 'The type of the Prometheus instance. Only Prometheus instances for Remote Write is supported. Set the value to RW.', 'type' => 'string', 'required' => true, 'example' => 'RW', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - '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. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'any', - 'example' => '"Data": {'."\n" - .' "nodes": ['."\n" - .' {'."\n" - .' "data": {'."\n" - .' "duration": 0.2254335260115607,'."\n" - .' "requests": 1211,'."\n" - .' "type": "MYSQL",'."\n" - .' "errors": 0'."\n" - .' },'."\n" - .' "id": "ggxw4lnjuz@c0507xxxx##MYSQL",'."\n" - .' "label": "mysql-pod:3306(cart_db)"'."\n" - .' }'."\n" - .' ],'."\n" - .' "edges": ['."\n" - .' {'."\n" - .' "data": {'."\n" - .' "duration": 0.03333333333333333,'."\n" - .' "requests": 600,'."\n" - .' "type": "UNKNOWN",'."\n" - .' "errors": 0'."\n" - .' },'."\n" - .' "id": "1974097372",'."\n" - .' "source": "ggxw4lnjuz@456xxxxx",'."\n" - .' "target": "ggxw4lnjuz@c0507xxxx"'."\n" - .' }'."\n" - .' ]'."\n" - .' }', - ], + 'Data' => ['description' => 'The struct returned. { "RequestId": the request ID, "Data": "{ "clusterType": the cluster type, "remoteWriteUrl": the public URL for remote write, "internetGrafanaUrl": the internal URL for Grafana, "authToken": indicates whether authentication is enabled, "internetPushGatewayUrl": the internal URL for Pushgateway, "clusterId": the cluster ID, "internetRemoteReadUrl": the internal URL for remote read, "remoteReadUrl": the public URL for remote read, "grafanaUrl": the public URL for Grafana, "pushGatewayUrl": the public URL for Pushgateway, "internetRemoteWriteUrl": the internal URL for remote write}" }', 'type' => 'string', 'example' => '{'."\n" + .' "RequestId": "1293091C-54AD-50FE-B787-E314B94B35AB",'."\n" + .' "Data": "{'."\n" + .' "clusterType":"remote-write-prometheus",'."\n" + .' "remoteWriteUrl":"http://cn-hu/api/v3/write",'."\n" + .' "internetGrafanaUrl":"https://cn-hanga/cn-hangzhou",'."\n" + .' "authToken":false,'."\n" + .' "internetPushGatewayUrl":"https://cangzhou/api/v2",'."\n" + .' "clusterId":"vrju1lj3sa|123456",'."\n" + .' "internetRemoteReadUrl":"https://cn-hangzh67cn-hangzhou/api/v1/read",'."\n" + .' "remoteReadUrl":"http://cn-hanou/api/v1/read",'."\n" + .' "grafanaUrl":"http://cn-angzhou",'."\n" + .' "pushGatewayUrl":"htt1lj3sa/cn-hangzhou/api/v2",'."\n" + .' "internetRemoteWriteUrl":"httpsngzhou/api/v3/write"}"'."\n" + .'}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ParameterRegionIdMissing', - 'errorMessage' => 'You must specify regionId.', - ], - [ - 'errorCode' => 'ParameterTopologyTypeIllegal', - 'errorMessage' => 'The specified topologyType is invalid.', - ], - [ - 'errorCode' => 'ParameterTimeStampIllegal', - 'errorMessage' => 'The specified timeStamp is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', - ], - ], - [ - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The application does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['ARMS::2019-08-08::CreatePrometheusInstance'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"null\\",\\n \\"Data\\": \\"\\\\\\"Data\\\\\\": {\\\\n \\\\\\"nodes\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"duration\\\\\\": 0.2254335260115607,\\\\n \\\\\\"requests\\\\\\": 1211,\\\\n \\\\\\"type\\\\\\": \\\\\\"MYSQL\\\\\\",\\\\n \\\\\\"errors\\\\\\": 0\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"ggxw4lnjuz@c0507xxxx##MYSQL\\\\\\",\\\\n \\\\\\"label\\\\\\": \\\\\\"mysql-pod:3306(cart_db)\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"edges\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"duration\\\\\\": 0.03333333333333333,\\\\n \\\\\\"requests\\\\\\": 600,\\\\n \\\\\\"type\\\\\\": \\\\\\"UNKNOWN\\\\\\",\\\\n \\\\\\"errors\\\\\\": 0\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"1974097372\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"ggxw4lnjuz@456xxxxx\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"ggxw4lnjuz@c0507xxxx\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n}","type":"json"}]', - 'title' => 'QueryAppTopology', - ], - 'GetAppApiByPage' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'AddPrometheusInstance', + 'changeSet' => [ + ['createdAt' => '2023-03-23T09:22:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-29T03:14:32.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusInstance'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"1293091C-54AD-50FE-B787-E314B94B35AB\\\\\\",\\\\n \\\\\\"Data\\\\\\": \\\\\\"{\\\\n \\\\\\"clusterType\\\\\\":\\\\\\"remote-write-prometheus\\\\\\",\\\\n \\\\\\"remoteWriteUrl\\\\\\":\\\\\\"http://cn-hu/api/v3/write\\\\\\",\\\\n \\\\\\"internetGrafanaUrl\\\\\\":\\\\\\"https://cn-hanga/cn-hangzhou\\\\\\",\\\\n \\\\\\"authToken\\\\\\":false,\\\\n \\\\\\"internetPushGatewayUrl\\\\\\":\\\\\\"https://cangzhou/api/v2\\\\\\",\\\\n \\\\\\"clusterId\\\\\\":\\\\\\"vrju1lj3sa|123456\\\\\\",\\\\n \\\\\\"internetRemoteReadUrl\\\\\\":\\\\\\"https://cn-hangzh67cn-hangzhou/api/v1/read\\\\\\",\\\\n \\\\\\"remoteReadUrl\\\\\\":\\\\\\"http://cn-hanou/api/v1/read\\\\\\",\\\\n \\\\\\"grafanaUrl\\\\\\":\\\\\\"http://cn-angzhou\\\\\\",\\\\n \\\\\\"pushGatewayUrl\\\\\\":\\\\\\"htt1lj3sa/cn-hangzhou/api/v2\\\\\\",\\\\n \\\\\\"internetRemoteWriteUrl\\\\\\":\\\\\\"httpsngzhou/api/v3/write\\\\\\"}\\\\\\"\\\\n}\\",\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'AddPrometheusIntegration' => [ + 'summary' => 'Adds an exporter to a Prometheus instance for Container Service or a Prometheus instance for ECS.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775806', - 'minimum' => '0', - 'example' => '1600063200000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => true, - 'maximum' => '9223372036854775806', - 'minimum' => '0', - 'example' => '1600066800000', - ], - ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '1', - 'default' => '1', - ], - ], - [ - 'name' => 'PageSize', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. This parameter is no longer supported. The number of entries to return on each page. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '1', - 'example' => '10', - 'default' => '10', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'IntervalMills', + 'name' => 'IntegrationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The time interval between the data shards to be queried. Unit: milliseconds. Minimum value: 60000. Maximum value: 2147483647.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'maximum' => '2147483647', - 'minimum' => '0', - 'example' => '60000', - 'default' => '0', - ], + 'schema' => ['title' => '', 'description' => 'The type of the integration.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kafka、mysql、redis、snmp、emr、nubela、tidb等'], ], [ - 'name' => 'PId', + 'name' => 'Param', 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application. For information about how to obtain a PID, see [Obtain the PID of an application](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a2n80plglh@745eddxxx', - ], + 'schema' => ['title' => '', 'description' => 'The configurations of the exporter. The value is a JSON string.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"port":"5554","name":"kafka-test12","kafka_instance":"kafka-test","__label_value":"kafka-test","scrape_interval":33,"metrics_path":"/metrics","__label_key":"kafka-test"}'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* 2XX: The request was successful.'."\n" - .'* 3XX: A redirection message was returned.'."\n" - .'* 4XX: The request was invalid.'."\n" - .'* 5XX: A server error occurred.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', - ], - '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', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '3703B98C-335E-5BA7-972E-F90E9E768A85'], 'Data' => [ 'description' => 'The struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Page' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Completed' => [ - 'description' => 'Is completed.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'Items' => [ - 'description' => 'The data entries.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The data entries returned.'."\n", - 'type' => 'object', - 'example' => '[]', - ], - ], + 'InstanceId' => ['description' => 'The ID of the exporter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2829', 'title' => ''], + 'InstanceName' => ['title' => '', 'description' => 'The name of the exporter.'."\n", 'type' => 'string', 'example' => 'hw-cloud02'], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code or error code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => 'The specified region is invalid.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], - 403 => [ - [ - 'errorCode' => 'RetcodeDailyCustomLimit', - 'errorMessage' => 'Usage today has exceeded the custom limit. The current operation is prohibited.', - ], - [ - 'errorCode' => 'RetcodeDailyFreeLimit', - 'errorMessage' => 'Usage today has exceeded the Essential Edition limit. The current operation is prohibited.', - ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'AddPrometheusIntegration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusIntegration'], ], + ], + 'ramActions' => [ [ - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The application does not exist.', - ], - [ - 'errorCode' => 'RunningTaskNotExist', - 'errorMessage' => 'Application data collection task does not exist or has been stopped.', - ], - ], - 429 => [ - [ - 'errorCode' => 'OperationIsThrottled', - 'errorMessage' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.', - ], - ], - 452 => [ - [ - 'errorCode' => 'OperationTimeOut', - 'errorMessage' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddPrometheusIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"RequestId\\": \\"B6A00968-82A8-4F14-9D1B-B53827DB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": \\"2\\",\\n \\"Page\\": 1,\\n \\"Completed\\": false,\\n \\"Items\\": [\\n []\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAppApiByPageResponse>\\n<Message>message</Message>\\n<RequestId>B6A00968-82A8-4F14-9D1B-B53827DB****</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <Total>0</Total>\\n <Page>1</Page>\\n <Items>[]</Items>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetAppApiByPageResponse>","errorExample":""}]', - 'title' => 'GetAppApiByPage', - 'summary' => 'Queries the API operations of application monitoring by page.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3703B98C-335E-5BA7-972E-F90E9E768A85\\",\\n \\"Data\\": {\\n \\"InstanceId\\": 2829,\\n \\"InstanceName\\": \\"hw-cloud02\\"\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'GetTrace' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AddRecordingRule' => [ + 'summary' => 'Creates or updates a recording rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TraceID', - 'in' => 'query', - 'schema' => [ - 'description' => 'The trace ID. You can log on to the ARMS console and obtain the trace ID on the **Trace Query** page or **Interface Snapshot** tab.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ac14001a15954493811405707d****', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n" - ."\n" - .'> If the ID of the trace is 30 characters in length, this parameter is optional. Otherwise, this parameter is required.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1623827602000', - ], - ], - [ - 'name' => 'EndTime', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n" - ."\n" - .'> If the ID of the trace is 30 characters in length, this parameter is optional. Otherwise, this parameter is required.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1623827603000', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'RuleYaml', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The custom recording rule. The value is in the YAML format.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'groups: - name: "recording_demo" rules: - expr: "sum(jvm_memory_max_bytes)" record: "rate_coredns_demo"', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries on each page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', - ], - 'Spans' => [ - 'description' => 'The details of the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SpanId' => [ - 'description' => 'The span ID.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'OperationName' => [ - 'description' => 'The name of the traced span.'."\n", - 'type' => 'string', - 'example' => '/api/demo', - ], - 'ResultCode' => [ - 'description' => 'The status code.'."\n", - 'type' => 'string', - 'example' => '222', - ], - 'Timestamp' => [ - 'description' => 'The timestamp generated when the span was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590388651', - ], - 'RpcType' => [ - 'description' => 'The type of the remote procedure call (RPC) mode.'."\n" - ."\n" - .'* 0: HTTP entry'."\n" - .'* 25: HTTP call'."\n" - .'* 1: High-speed Service Framework (HSF) call'."\n" - .'* 2: HSF provision'."\n" - .'* 40: on-premises API call'."\n" - .'* 60: MySQL call'."\n" - .'* 62: Oracle call'."\n" - .'* 63: PostgreSQL call'."\n" - .'* 70: Redis call'."\n" - .'* 4: Taobao Distributed Data Layer (TDDL) call'."\n" - .'* 5: Tair call'."\n" - .'* 13: MetaQ message sending'."\n" - .'* 252: MetaQ message receiving'."\n" - .'* 3: notification sending'."\n" - .'* 254: notification receiving'."\n" - .'* 7: Apache Dubbo call'."\n" - .'* 8: Apache Dubbo provision'."\n" - .'* 19: SOFARPC call'."\n" - .'* 18: SOFARPC provision'."\n" - .'* 11: Distributed Service Framework (DSF) call'."\n" - .'* 12: DSF provision'."\n" - .'* \\-1: unknown call'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'ServiceIp' => [ - 'description' => 'The IP address of the host where the application resides.'."\n", - 'type' => 'string', - 'example' => '172.20.XX.XX', - ], - 'HaveStack' => [ - 'description' => 'Indicates whether a method stack was provided.'."\n" - ."\n" - .'* `true`: A method stack was provided.'."\n" - .'* `false`: No method stack was provided.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ParentSpanId' => [ - 'description' => 'The ID of the parent span.'."\n", - 'type' => 'string', - 'example' => '18', - ], - 'Duration' => [ - 'description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1000', - ], - 'RpcId' => [ - 'description' => 'The ID of the RPC mode.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'ServiceName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'arms-demo', - ], - 'TraceID' => [ - 'description' => 'The trace ID.'."\n", - 'type' => 'string', - 'example' => 'ac14001a15954493811405707d****', - ], - 'TagEntryList' => [ - 'description' => 'The tags of the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'http.status.code', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '200', - ], - ], - 'description' => '', - ], - ], - 'LogEventList' => [ - 'description' => 'The log events in the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => 'The timestamp when the log event was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1590388651', - ], - 'TagEntryList' => [ - 'description' => 'The tags of the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'http.status.code', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '200', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'Children' => [ - 'description' => 'The child spans of the current span.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the child span.'."\n", - 'type' => 'object', - 'example' => '[ { "ParentSpanId":"c33603355032xxxx", "ServiceIp":"10.208.xxx.xxx", "OperationName":"/product/toy/8ac7ddeb-1c3c-4911-850c-665a5a0xxxx", "RpcType":0, "Duration":2, "TagEntryList":[ { "Value":"10.208.0.xxx", "Key":"source.ip" } ], "Timestamp":1652669026201, "HaveStack":true, "LogEventList":[ ], "ServiceName":"xxxxxx", "RpcId":"0.2", "TraceID":"ea1ad000a1165266902619685xxxxx", "Children":[ ], "ResultCode":"0", "SpanId":"7069ab30d7cbxxxx" } ]', - ], - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****'], + 'Data' => ['description' => 'The status of the response.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Spans\\": [\\n {\\n \\"SpanId\\": \\"1234\\",\\n \\"OperationName\\": \\"/api/demo\\",\\n \\"ResultCode\\": \\"222\\",\\n \\"Timestamp\\": 1590388651,\\n \\"RpcType\\": 1,\\n \\"ServiceIp\\": \\"172.20.XX.XX\\",\\n \\"HaveStack\\": false,\\n \\"ParentSpanId\\": \\"18\\",\\n \\"Duration\\": 1000,\\n \\"RpcId\\": \\"0\\",\\n \\"ServiceName\\": \\"arms-demo\\",\\n \\"TraceID\\": \\"ac14001a15954493811405707d****\\",\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ],\\n \\"LogEventList\\": [\\n {\\n \\"Timestamp\\": 1590388651,\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n }\\n ],\\n \\"Children\\": [\\n [\\n {\\n \\"ParentSpanId\\": \\"c33603355032xxxx\\",\\n \\"ServiceIp\\": \\"10.208.xxx.xxx\\",\\n \\"OperationName\\": \\"/product/toy/8ac7ddeb-1c3c-4911-850c-665a5a0xxxx\\",\\n \\"RpcType\\": 0,\\n \\"Duration\\": 2,\\n \\"TagEntryList\\": [\\n {\\n \\"Value\\": \\"10.208.0.xxx\\",\\n \\"Key\\": \\"source.ip\\"\\n }\\n ],\\n \\"Timestamp\\": 1652669026201,\\n \\"HaveStack\\": true,\\n \\"LogEventList\\": [],\\n \\"ServiceName\\": \\"xxxxxx\\",\\n \\"RpcId\\": \\"0.2\\",\\n \\"TraceID\\": \\"ea1ad000a1165266902619685xxxxx\\",\\n \\"Children\\": [],\\n \\"ResultCode\\": \\"0\\",\\n \\"SpanId\\": \\"7069ab30d7cbxxxx\\"\\n }\\n ]\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetTraceResponse>\\n <RequestId>6A9AEA84-7186-4D8D-B498-4585C6A2****</RequestId>\\n <Spans>\\n <SpanId>1234</SpanId>\\n <OperationName>/api/demo</OperationName>\\n <ResultCode>222</ResultCode>\\n <Timestamp>1590388651</Timestamp>\\n <RpcType>1</RpcType>\\n <ServiceIp>172.20.XX.XX</ServiceIp>\\n <HaveStack>false</HaveStack>\\n <ParentSpanId>18</ParentSpanId>\\n <Duration>1000</Duration>\\n <RpcId>0</RpcId>\\n <ServiceName>arms-demo</ServiceName>\\n <TraceID>ac14001a15954493811405707d****</TraceID>\\n <TagEntryList>\\n <Key>http.status.code</Key>\\n <Value>200</Value>\\n </TagEntryList>\\n <LogEventList>\\n <Timestamp>1590388651</Timestamp>\\n <TagEntryList>\\n <Key>http.status.code</Key>\\n <Value>200</Value>\\n </TagEntryList>\\n </LogEventList>\\n <Children/>\\n </Spans>\\n</GetTraceResponse>","errorExample":""}]', - 'title' => 'GetTrace', - 'summary' => 'Queries the details of a trace.', - 'description' => '> You must use Application Real-Time Monitoring Service (ARMS) SDK for Java V2.7.24.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetStack' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"Data\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddRecordingRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <Data>success</Data>\\n</AddRecordingRuleResponse>","errorExample":""}]', + 'title' => 'AddRecordingRule', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-19T06:33:41.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddRecordingRule'], + ], ], + 'ramActions' => [], + ], + 'AddTagToFlinkCluster' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TraceID', - 'in' => 'query', - 'schema' => [ - 'description' => 'The trace ID. It is displayed on the **Trace Explorer** page in the Application Real-Time Monitoring Service (ARMS) console.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0a5800611641470044457853******', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RpcID', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the remote procedure call (RPC) mode. You can obtain the ID by calling the **GetTrace** operation.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '0.1', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c5defa51f******c92bd2ef5fb093269'], ], [ - 'name' => 'Pid', + 'name' => 'TargetUserId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application. For more information about how to obtain the PID, see [Obtain the PID of an application](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'eb4zdose6v@36bab313a******', - ], + 'schema' => ['description' => 'The ID of the Alibaba Cloud account to which the Flink workspace belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => '198608******7619', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'FlinkWorkSpaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The entry timestamp of the method call. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1653555396', - ], + 'schema' => ['description' => 'The ID of the Flink workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ab18f***93744d', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'FlinkWorkSpaceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The exit timestamp of the method call. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1653641800', - ], + 'schema' => ['description' => 'The name of the Flink workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'flink-demo', 'title' => ''], ], [ - 'name' => 'SpanID', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The span ID of the trace. It is displayed on the Trace Explorer page in the ARMS console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '88c32dfa4b******', - ], + 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'B34C3A43-A901-5F94-9DAD-758CE4******', - ], - 'StackInfo' => [ - 'description' => 'The method stack details.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The start time of the call method.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1653555396', - ], - 'Exception' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'java.lang.NullPointerException', - ], - 'Api' => [ - 'description' => 'The name of the operation.'."\n", - 'type' => 'string', - 'example' => 'Tomcat Servlet Process', - ], - 'Line' => [ - 'description' => 'The number of rows in the method stack information.'."\n", - 'type' => 'string', - 'example' => '34', - ], - 'Duration' => [ - 'description' => 'The duration. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '32', - ], - 'RpcId' => [ - 'description' => 'The ID of the RPC mode.'."\n", - 'type' => 'string', - 'example' => '0.1', - ], - 'ServiceName' => [ - 'description' => 'The name of the service.'."\n", - 'type' => 'string', - 'example' => '/com/test', - ], - 'CallCount' => [ - 'description' => 'The number of times the method is called.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ExtInfo' => [ - 'description' => 'The information about the array object.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the custom parameter.'."\n", - 'type' => 'string', - 'example' => '41', - ], - 'Info' => [ - 'description' => 'The content of the custom parameter.'."\n", - 'type' => 'string', - 'example' => 'input=254275&', - ], - ], - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the business logic was executed. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'AddTagToFlinkCluster', + 'summary' => 'Attaches the workspace ID and workspace name tags to the Prometheus instance corresponding to a Flink workspace.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagToFlinkCluster'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"B34C3A43-A901-5F94-9DAD-758CE4******\\",\\n \\"StackInfo\\": [\\n {\\n \\"StartTime\\": 1653555396,\\n \\"Exception\\": \\"java.lang.NullPointerException\\",\\n \\"Api\\": \\"Tomcat Servlet Process\\",\\n \\"Line\\": \\"34\\",\\n \\"Duration\\": 32,\\n \\"RpcId\\": \\"0.1\\",\\n \\"ServiceName\\": \\"/com/test\\",\\n \\"CallCount\\": \\"1\\",\\n \\"ExtInfo\\": {\\n \\"Type\\": \\"41\\",\\n \\"Info\\": \\"input=254275&\\"\\n }\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetStackResponse>\\n <RequestId>B34C3A43-A901-5F94-9DAD-758CE4******</RequestId>\\n <StackInfo>\\n <StartTime>1641780817536</StartTime>\\n <Exception>java.lang.NullPointerException</Exception>\\n <Api>Tomcat Servlet Process</Api>\\n <Line>34</Line>\\n <Duration>32</Duration>\\n <RpcId>0</RpcId>\\n <ServiceName>/com/test</ServiceName>\\n <ExtInfo>\\n <Type>41</Type>\\n <Info>input=254275&</Info>\\n </ExtInfo>\\n </StackInfo>\\n</GetStackResponse>","errorExample":""}]', - 'title' => 'GetStack', - 'summary' => 'Queries the information of a method stack.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": \\"false\\"\\n}","type":"json"}]', ], - 'GetMultipleTrace' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'AppendInstancesToPrometheusGlobalView' => [ + 'summary' => 'Adds a data source to a global aggregation instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => true, 'tenantRelevance' => 'publicInformation'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'TraceIDs', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The trace IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The trace ID. You can specify one to nine trace IDs. You can log on to the Application Real-Time Monitoring Service (ARMS) console and obtain the trace ID on the **Trace Query** page.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ac1400a115951745017447033d****', - ], - 'required' => true, - 'example' => 'ac1400a115951745017447033d****', - 'maxItems' => 10, - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'GroupName', 'in' => 'query', - 'schema' => [ - 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', - 'description' => 'The start time of the trace. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1657692507000', - ], + 'schema' => ['description' => 'The name of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'Clusters', 'in' => 'query', - 'schema' => [ - 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', - 'description' => 'The time when the trace ends. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1663999380000', - ], + 'schema' => ['description' => 'The list of global aggregation instances. The value is a JSON string.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ { "sourceName": "数据源名称- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId", }, { "sourceName": "数据源名称 - MetrcStore No.2", "sourceType":"MetricStore", "dataSource":"MetricStore的 remote read 地址", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"自建Prometheus数据源 remoteread地址", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"其他数据源如Tencent remoteread地址", "headers":{ "AnyHeaderToFill":"需要填充的Headers" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'GlobalViewClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: `1`.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return per page, the maximum value is 1000.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'global-v2-cn-1670100631025794-6gjc0qgb', 'title' => ''], ], ], 'responses' => [ @@ -2609,203 +943,47 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', - ], - 'MultiCallChainInfos' => [ - 'description' => 'The details of traces.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'TraceID' => [ - 'description' => 'The trace ID.'."\n", - 'type' => 'string', - 'example' => 'ac1400a115951745017447033d****', - ], - 'Spans' => [ - 'description' => 'The details of the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SpanId' => [ - 'description' => 'The span ID.'."\n", - 'type' => 'string', - 'example' => '1234', - ], - 'OperationName' => [ - 'description' => 'The name of the traced span.'."\n", - 'type' => 'string', - 'example' => '/demo/queryNotExistDB/11', - ], - 'ResultCode' => [ - 'description' => 'The status code returned.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Timestamp' => [ - 'description' => 'The timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1595174501747', - ], - 'RpcType' => [ - 'description' => 'The type of the remote procedure call (RPC) mode.'."\n" - ."\n" - .'* 0: HTTP entry'."\n" - .'* 25: HTTP call'."\n" - .'* 1: High-speed Service Framework (HSF) call'."\n" - .'* 2: HSF provision'."\n" - .'* 40: on-premises API call'."\n" - .'* 60: MySQL call'."\n" - .'* 62: Oracle call'."\n" - .'* 63: PostgreSQL call'."\n" - .'* 70: Redis call'."\n" - .'* 4: Taobao Distributed Data Layer (TDDL) call'."\n" - .'* 5: Tair call'."\n" - .'* 13: MetaQ message sending'."\n" - .'* 252: MetaQ message receiving'."\n" - .'* 3: notification sending'."\n" - .'* 254: notification receiving'."\n" - .'* 7: Apache Dubbo call'."\n" - .'* 8: Apache Dubbo provision'."\n" - .'* 19: SOFARPC call'."\n" - .'* 18: SOFARPC provision'."\n" - .'* 11: Distributed Service Framework (DSF) call'."\n" - .'* 12: DSF provision'."\n" - .'* \\-1: unknown call'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ServiceIp' => [ - 'description' => 'The IP address of the host where the application resides.'."\n", - 'type' => 'string', - 'example' => '172.20.XX.XX', - ], - 'HaveStack' => [ - 'description' => 'Indicates whether a method stack was provided.'."\n" - ."\n" - .'* `true`: A method stack was provided.'."\n" - .'* `false`: No method stack was provided.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ParentSpanId' => [ - 'description' => 'The ID of the parent span.'."\n", - 'type' => 'string', - 'example' => '18', - ], - 'Duration' => [ - 'description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '11', - ], - 'RpcId' => [ - 'description' => 'RPC ID'."\n", - 'type' => 'string', - 'example' => '0.1', - ], - 'ServiceName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'arms-k8s-demo-subcomponent', - ], - 'TraceID' => [ - 'description' => 'The trace ID.'."\n", - 'type' => 'string', - 'example' => 'ac1400a115951745017447033d****', - ], - 'TagEntryList' => [ - 'description' => 'The tags of the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'http.status.code', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '200', - ], - ], - 'description' => '', - ], - ], - 'LogEventList' => [ - 'description' => 'The log events in the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Timestamp' => [ - 'description' => 'The time when the log was generated. The value is a timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1595174501747', - ], - 'TagEntryList' => [ - 'description' => 'The tags of the trace.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'http.status.code', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => '200', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', + 'Data' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + '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', 'title' => ''], + 'Msg' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Info' => ['description' => 'The Info-level information.'."\n", 'type' => 'string', 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源JSON list中，添加失败的单个JSON的list}', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Additional message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"MultiCallChainInfos\\": [\\n {\\n \\"TraceID\\": \\"ac1400a115951745017447033d****\\",\\n \\"Spans\\": [\\n {\\n \\"SpanId\\": \\"1234\\",\\n \\"OperationName\\": \\"/demo/queryNotExistDB/11\\",\\n \\"ResultCode\\": \\"1\\",\\n \\"Timestamp\\": 1595174501747,\\n \\"RpcType\\": 0,\\n \\"ServiceIp\\": \\"172.20.XX.XX\\",\\n \\"HaveStack\\": true,\\n \\"ParentSpanId\\": \\"18\\",\\n \\"Duration\\": 11,\\n \\"RpcId\\": \\"0.1\\",\\n \\"ServiceName\\": \\"arms-k8s-demo-subcomponent\\",\\n \\"TraceID\\": \\"ac1400a115951745017447033d****\\",\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ],\\n \\"LogEventList\\": [\\n {\\n \\"Timestamp\\": 1595174501747,\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetMultipleTraceResponse>\\n\\t<RequestId>2983BEF7-4A0D-47A2-94A2-8E9C5E63****</RequestId>\\n\\t<MultiCallChainInfos>\\n\\t\\t<TraceID>ac1400a115951745017447033d****</TraceID>\\n\\t\\t<Spans>\\n\\t\\t\\t<HaveStack>true</HaveStack>\\n\\t\\t\\t<ServiceIp>172.20.XX.XX</ServiceIp>\\n\\t\\t\\t<OperationName>/demo/queryNotExistDB/11</OperationName>\\n\\t\\t\\t<ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n\\t\\t\\t<RpcId>0.1</RpcId>\\n\\t\\t\\t<RpcType>0</RpcType>\\n\\t\\t\\t<TraceID>ac1400a115951745017447033d****</TraceID>\\n\\t\\t\\t<Duration>11</Duration>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>200</Value>\\n\\t\\t\\t\\t<Key>http.status.code</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>172.20.XX.XX</Value>\\n\\t\\t\\t\\t<Key>source.ip</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<Timestamp>1595174501747</Timestamp>\\n\\t\\t\\t<ResultCode>1</ResultCode>\\n\\t\\t</Spans>\\n\\t</MultiCallChainInfos>\\n\\t<MultiCallChainInfos>\\n\\t\\t<TraceID>ac1400a115951745017577035d****</TraceID>\\n\\t\\t<Spans>\\n\\t\\t\\t<HaveStack>true</HaveStack>\\n\\t\\t\\t<ServiceIp>172.20.XX.XX</ServiceIp>\\n\\t\\t\\t<OperationName>/demo/queryException/12</OperationName>\\n\\t\\t\\t<ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n\\t\\t\\t<RpcId>0.1</RpcId>\\n\\t\\t\\t<RpcType>0</RpcType>\\n\\t\\t\\t<TraceID>ac1400a115951745017577035d****</TraceID>\\n\\t\\t\\t<Duration>2</Duration>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>500</Value>\\n\\t\\t\\t\\t<Key>http.status.code</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>172.20.XX.XX</Value>\\n\\t\\t\\t\\t<Key>source.ip</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<Timestamp>1595174501761</Timestamp>\\n\\t\\t\\t<ResultCode>1</ResultCode>\\n\\t\\t</Spans>\\n\\t</MultiCallChainInfos>\\n</GetMultipleTraceResponse>","errorExample":""}]', - 'title' => 'GetMultipleTrace', - 'summary' => 'Queries the details of one or more traces.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ConfigApp' => [ - 'summary' => 'Turns on or off the main switch of an ARMS agent, or queries the status of the main switch.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'AppendInstancesToPrometheusGlobalView', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppendInstancesToPrometheusGlobalView'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源JSON list中，添加失败的单个JSON的list}\\"\\n },\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ApplyScenario' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -2813,181 +991,83 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'AppIds', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application. Separate multiple PIDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'iioe7jcnuk@582846f37******,atc889zkcf@d8deedfa9bf******', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjiakou', 'title' => ''], ], [ - 'name' => 'Enable', + 'name' => 'Scenario', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on or off the main switch of the ARMS agent. The monitoring stops after the switch is turned off. If you do not specify this parameter, the main switch status of the ARMS agent is queried.'."\n" - ."\n" - .'* `true`: turns on the switch'."\n" - .'* `false`: turns off the switch'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The scenario where you want to use the business monitoring job. Valid values:'."\n" + ."\n" + .'* `USER-DEFINED`: user-defined. This is the default value.'."\n" + .'* `EDAS-ROLLOUT`: application release in Enterprise Distributed Application Service (EDAS)'."\n" + .'* `OAM-ROLLOUT`: application release based on Open Application Model (OAM)'."\n" + .'* `MSC-CANARY`: canary release based on Microservice Engine (MSE)'."\n", 'type' => 'string', 'required' => false, 'example' => 'USER-DEFINED', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the business monitoring job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试POP业务监控', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application. Set the value to **TRACE**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TRACE', - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b590lhguqs@28f515462f******', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'headers' => [], - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The result of turning on or off the main switch of the agent or the main switch status of the agent. Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* success'."\n" - .'* failed'."\n" - ."\n" - .'The main switch status of the agent. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'abc@def success\\nghi@jkl success\\n', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - ], - 'description' => '', - ], + [ + 'name' => 'Sign', + 'in' => 'query', + 'schema' => ['description' => 'The code of the business monitoring job. This parameter is not required when you create a business monitoring job. However, this parameter is required when you update a business monitoring job.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'a9f8****', 'title' => ''], ], - ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '必选参数不能为空', - ], + [ + 'name' => 'Config', + 'in' => 'query', + 'style' => 'json', + 'schema' => ['description' => 'The configuration of the business monitoring job. The value is a JSON string. For more information about this parameter, see the following additional information about the **Config** parameter.'."\n", 'type' => 'object', 'required' => true, 'docRequired' => true, 'example' => '{"rpcType":"0","nameMatchType":"EQUALS","service":"/api/pop/test","operator":"and","filterItems":[{"type":"HttpHeaders","key":"uid","opt":"==","value":"123456789"}],"group":{"type":"HttpRequestParameters","key":"name"}}', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"abc@def success\\\\\\\\nghi@jkl success\\\\\\\\n\\",\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfigAppResponse>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n <Data>abc@def success\\\\nghi@jkl success\\\\n</Data>\\n</ConfigAppResponse>","errorExample":""}]', - 'title' => 'ConfigApp', - 'description' => '****', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SaveTraceAppConfig' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'SnTransfer', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the coloring sign is transparently passed down to downstream application nodes in the trace.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`: This is the default value.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'SnStat', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID (PID) of the application.'."\n" - ."\n" - .'Log on to the ARMS console. In the left-side navigation pane, choose **Application Monitoring** > **Application List**. On the Application List page, click the name of an application. The URL in the address bar contains the PID of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with an at sign (@) to obtain xxx@74xxx.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'a2n80plglh@745eddxxx', - ], + 'schema' => ['description' => 'Specifies whether to count traffic based on the coloring sign.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`: This is the default value.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Settings', + 'name' => 'SnDump', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The settings of Application Monitoring.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the settings that you want to modify. For more information about the supported settings, see the following sections.'."\n" - ."\n" - .'* Trace sampling settings'."\n" - .'* Agent switch settings'."\n" - .'* Threshold settings'."\n" - .'* Advanced settings'."\n" - .'* Thread settings'."\n" - .'* Memory snapshot settings'."\n" - .'* URL convergence settings'."\n" - .'* Business log association settings'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sampling.enable', - ], - 'Value' => [ - 'description' => 'The value of the settings that you want to modify. For more information about the supported settings, see the following sections.'."\n" - ."\n" - .'* Trace sampling settings'."\n" - .'* Agent switch settings'."\n" - .'* Threshold settings'."\n" - .'* Advanced settings'."\n" - .'* Thread settings'."\n" - .'* Memory snapshot settings'."\n" - .'* URL convergence settings'."\n" - .'* Business log association settings'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 256, - ], + 'schema' => ['description' => 'Specifies whether to record business parameters to the trace marked with the coloring sign.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`: This is the default value.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'SnForce', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether traffic in the trace marked with the coloring sign is all collected.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`: This is the default value.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'UpdateOption', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether the operation is an update operation.'."\n" + ."\n" + .'* `true`: update'."\n" + .'* `false`: insert'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -2995,211 +1075,120 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Result' => ['description' => 'The code of the business monitoring job, which is the coloring sign.'."\n", 'type' => 'string', 'example' => '2b97****', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EA24D522-AD35-47B8-8CB2-ADBC38******', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ParameterTraceAppSettingKeyIllegal', - 'errorMessage' => 'The application configuration key is invalid.', - ], - [ - 'errorCode' => 'ParameterTraceAppSettingValueIllegal', - 'errorMessage' => 'The application configuration value is invalid.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'InterPlease try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - ], - 404 => [ - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The application does not exist.', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SaveTraceAppConfigResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <Data>success</Data>\\n</SaveTraceAppConfigResponse>","errorExample":""}]', - 'title' => 'SaveTraceAppConfig', - 'summary' => 'Modifies the settings of Application Monitoring, such as trace sampling and agent switch settings.', - 'requestParamsDescription' => '**Trace sampling settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|sampling.enable|Specifies whether to turn on the sampling switch.|Valid values:\\- `true`: turns on the sampling switch\\- `false`: turns off the sampling switch|'."\n" - .'|sampling.rate|The sampling rate.|Valid values: 0 to 100. Default value: 10.|'."\n" - ."\n" - .'**Agent switch settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|enable|Specifies whether to turn on the agent switch.|Valid values:\\- `true`: turns on the agent switch\\- `false`: turns off the agent switch|'."\n" - ."\n" - .'**Threshold settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|thresholds.limit|The throttling threshold.|Default value: 100.|'."\n" - .'|thresholds.interface|The threshold of response time for API calls.|Default value: 500. Unit: ms.|'."\n" - .'|thresholds.sql|The threshold of the amount of time consumed by slow SQL queries.|Default value: 500. Unit: ms.|'."\n" - ."\n" - .'**Advanced settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|defined.excludeurl|The invalid API calls that you want to exclude.|Separate multiple API calls with commas (,).Default value: /\\*\\*/\\*.jpg,/\\*\\*/\\*.png,/\\*\\*/\\*.js,/\\*\\*/\\*.jpeg.Example: /service/taobao,/service/status.|'."\n" - .'|callstack.maxLength|The maximum length of method stacks.|Default value: 128. Maximum value: 400.|'."\n" - .'|exception.stacktrace|The stack depth based on which the system identifies the same type of exceptions.|Default value: 2. The system identifies the same type of exceptions based on the specified stack depth. If you change the value, unexpected statistics may occur. **Proceed with caution**.|'."\n" - .'|callsql.maxLength|The maximum length of collected SQL statements.|A collected SQL statement must be 256 to 4096 characters in length. Default value: 1024.|'."\n" - .'|jdbc.tracesqlbindvalue|Specifies whether to capture variables bound to the PrepareStatement parameter.|Valid values:\\-`true`: turns on the switch of capturing variables bound to the PrepareStatement parameter\\- `false`: turns off the switch of capturing variables bound to the PrepareStatement parameter|'."\n" - .'|jdbc.tracesqlraw|Specifies whether to capture raw SQL statements.|Valid values:\\- `true`: turns on the switch of capturing raw SQL statements\\- `false`: turns off the switch of capturing raw SQL statements|'."\n" - .'|exception.whitelist|The exceptions that you want to exclude.|The value must be a regular expression that specifies the name of an exception category. Separate multiple exception categories with commas (,). Example: java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException. The exceptions of the categories that you specify are not displayed in the charts on the Application Details and Exceptions Diagnosis pages.|'."\n" - .'|error.skip|The errors that you want to exclude.|By default, all HTTP status codes greater than 400 are counted as errors. To ignore specific HTTP status codes greater than 400, you can specify them as the value of this key. This way, they are not counted as errors. Separate multiple HTTP status codes with commas (,). Examples: 429 and 429,512. This key is supported by agent version 2.5.7.2 or later.|'."\n" - .'|compress.enable|Specifies whether to turn on the trace compression switch.|Valid values:\\- `true`: turns on the trace compression switch\\- `false`: turns off the trace compression switch|'."\n" - .'|param.maxLength|The maximum length of request parameters.|Default value: 512. If the value is higher than the default value, additional system resources are consumed. **Exercise caution when you configure this key**.|'."\n" - .'|quantile.enable|Specifies whether to turn on the quantile statistics switch.|Valid values:\\- `true`: turns on the quantile statistics switch\\- `false`: turns off the quantile statistics switch|'."\n" - .'|threadpoolmonitor.enable|Specifies whether to enable thread pool and connection pool monitoring.|**The configuration of this key takes effect after the application is restarted**.Valid values:\\- `true`: enables thread pool and connection pool monitoring\\- `false`: disables thread pool and connection pool monitoring|'."\n" - .'|async.autoTransmit|Specifies whether to turn on the automatic asynchronous propagation switch.|**This key is valid only when the agent version is 2.8.3 or later**.**The configuration of this key takes effect after the application is restarted**. This feature encapsulates the Runnable and Callable tasks that are submitted to the thread pool to propagate the context. Potential risks may arise. **Exercise caution when you configure this key**.Valid values:\\-`true`: turns on the automatic asynchronous propagation switch\\- `false`: turns off the automatic asynchronous propagation switch|'."\n" - .'|thread.match.package|The name of the package for asynchronous propagation.|**This key is valid only when the agent version is 2.7.1.3 or later**.**The configuration of this key takes effect after the application is restarted**. When a Runnable, Callable, Supplier under the specified package is created, the trace context is automatically captured and propagated to the new thread. Separate multiple package names with commas (,).|'."\n" - .'|responseInject.enable|Specifies whether to turn on the switch of returning the trace ID in the request.|Valid values:\\- `true`: turns on the switch\\- `false`: turns off the switch|'."\n" - ."\n" - .'**Thread settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|tprof.enableThreadProfiler|Specifies whether to turn on the main switch of thread profiling.|Valid values:\\- `true`: turns on the switch\\- `false`: turns off the switchIf you turn on this switch, the native method stacks of slow API calls are automatically saved.|'."\n" - .'|tprof.threadProfilerSlowInteractionRt|The threshold of the amount of time consumed by slow API calls.|Default value: 2000. If the amount of time consumed by slow API calls exceeds the threshold, thread profiling is enabled. We recommend that you set the value to the 99th percentile of the amount of time consumed. If you set a value smaller than 2000, the CPU consumption is increased. We recommend that you set a value greater than or equal to 500.|'."\n" - .'|tprof.enableThreadStackRecorder|Specifies whether to enable thread profiling for method stacks.|Valid values:\\- `true`: enables thread profiling for method stacks\\- `false`: disables thread profiling for method stacksIf you enable thread profiling, method stacks are collected every 5 minutes.|'."\n" - ."\n" - .'**Business log association settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|logging.enable|Specifies whether to turn on the switch to associate trace IDs with business logs.|Valid values:\\- `true`: turns on the switch\\- `false`: turns off the switchIf you turn on this switch, trace IDs are automatically generated in the business logs of an application. This setting takes effect after you restart the application. Logging utilities such as Log4j, Log4j2, and Logback are supported. You must add %X{EagleEye-TraceID} to the log layout to generate trace IDs.|'."\n" - .'|SLS.project|The Simple Log Service project that stores the business logs generated in the current region.|You can specify the name of a Simple Log Service project that stores the business logs generated in the current region.|'."\n" - .'|SLS.logStore|The Simple Log Service Logstore that stores the business logs generated in the current region.|You can specify the name of a Simple Log Service Logstore that stores the business logs generated in the current region.|'."\n" - .'|SLS.index|The type of indexes of business logs generated in the current region.|Valid values:\\- If you want to use full-text indexes, do not set this key.\\- If you want to use a field-specific index, set the value to the field name. Example: **SLS.index: tag**.For more information about the differences between field-specific indexes and full-text indexes, see [Configure indexes](~~90732~~).|'."\n" + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": \\"2b97****\\",\\n \\"RequestId\\": \\"EA24D522-AD35-47B8-8CB2-ADBC38******\\"\\n}","type":"json"}]', + 'title' => 'Create or update Business Monitoring', + 'summary' => 'Create or update Business Monitoring.', + 'requestParamsDescription' => '## Additional description for the **Config** parameter '."\n" + .'**Sample JSON string and explanation**'."\n" ."\n" - .'**URL convergence settings**'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|convergence.enable|Specifies whether to enable the URL convergence feature.|Valid values:\\- `true`: enables the URL convergence feature\\- `false`: disables the URL convergence feature|'."\n" - .'|convergence.minServerSize|The convergence threshold.|If the threshold is exceeded, convergence is performed.|'."\n" - .'|convergence.pattern|The regular expression of convergence rules.|You can use regular expressions to configure convergence rules. Separate multiple regular expressions with commas (,). Enter a URL in the original text to indicate that the URL is not converged. Example: /service/(.\\*?)/demo.|'."\n" - ."\n" - .'**Arthas diagnostics settings**'."\n" - ."\n" - .'****Note: The Arthas diagnostics settings take effect only when the agent version is 2.7.1.3 or later. For more information about other prerequisites, see [Arthas diagnostics](~~300078~~).****'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|arthas.enable|Specifies whether to turn on the Arthas switch.|Valid values:\\- `true`: turns on the Arthas switch\\- `false`: turns off the Arthas switch|'."\n" - .'|arthas.enableIps|The IP addresses for which the Arthas diagnostics feature is enabled.|If you configure this key, the Arthas diagnostics feature takes effect only on the specified IP addresses. If you do not configure this key, the Arthas diagnostics feature takes effect on all IP addresses by default. Separate multiple IP addresses with commas (,).|'."\n" - ."\n" - .'**Continuous profiling settings**'."\n" - ."\n" - .'****Note: The continuous profiling settings take effect only when the agent version is 2.7.3.5 or later. For more information about other prerequisites, see [Continuous profiling](~~473143~~).****'."\n" - ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|cp.enable|Specifies whether to turn on the continuous profiling switch.|Valid values:\\- `true`: turns on the continuous profiling switch\\- `false`: turns off the continuous profiling switch\\* If you turn on this switch, you must configure the IP addresses on which the switch takes effect. Otherwise, the switch does not take effect. You can configure the IP addresses in the following two modes.|'."\n" - ."\n" - .'|||||'."\n" - .'|---|---|---|---|'."\n" - .'|Mode|Key|Description|Value|'."\n" - .'|IP address whitelist|cp.allowIPs|IP address whitelist|The IP addresses of the instances for which continuous profiling is enabled. Separate multiple IP addresses with commas (,).Example: 192.168.0.1,192.168.0.2|'."\n" - .'|cp.allowNetwork|CIDR block|Specify an empty string. Otherwise, continuous profiling does not work properly.|'."\n" - .'|CIDR block|cp.allowIPs|IP address whitelist|Specify an empty string. Otherwise, continuous profiling does not work properly.|'."\n" - .'|cp.allowNetwork|CIDR block|The CIDR block of the instances for which continuous profiling is enabled.Example: 192.168.2.0/24/24|'."\n" - ."\n" - .'**Data masking settings** ****Note: The data masking settings take effect only when the agent version is 2.9.0 or later.****'."\n" + .'```'."\n" + .'{'."\n" + .' "rpcType":"0", // Service Type. 0: HTTP entry; 255: Kubernetes Pod Metadata.'."\n" + .' "nameMatchType":"EQUALS", // Service Name matching rule. EQUALS: equals; STARTSWITH: starts with; CONTAINS: contains; ENDSWITH: ends with; PATTERNS: pattern matching.'."\n" + .' "service":"/api/pop/test", // Service Name.'."\n" + .' "operator":"and", // Relationship between filter rules. and: all rules must be satisfied; or: any one rule is sufficient.'."\n" + .' "filterItems": // Filter rules.'."\n" + .' [{'."\n" + .' "type":"HttpHeaders", // Parameter for filter rule matching. See the next section for details.'."\n" + .' "key":"uid", // Key of the field to match for filtering.'."\n" + .' "opt":"==", // Matching method. Supports ==, !=, and contains.'."\n" + .' "value":"123456789" // Threshold value for the filter field.'."\n" + .' }],'."\n" + .' "group": // Grouping rule.'."\n" + .' {'."\n" + .' "type":"HttpRequestParameters", // Parameter for grouping rule matching. See the next section for details.'."\n" + .' "key":"name" // Key of the field to match for grouping.'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" ."\n" - .'|Key|Description|Value|'."\n" - .'|---|---|---|'."\n" - .'|sanitizer.enable|Specifies whether to turn on the data masking switch.|Valid values:\\- `true`: turns on the data masking switch\\- `false`: turns off the data masking switch|'."\n" - .'|sanitizer.keys|The data masking rules.|You can specify rules for data masking, as shown in the example. The specified rules are used as keys for exact matching. For example, if you specify password, the rule is equivalent to the regular expression .\\*password.\\*. The keys are not case-sensitive. Separate multiple rules with commas (,).Example: password,secret,key,token, and credentials|', + .'**Parameters for filter rule matching**'."\n" + ."\n" + .'When Service Type is set to rpcType=0 (HTTP entry), the available parameters are:'."\n" + .'- HttpRequestParameters'."\n" + .'- HttpHeaders'."\n" + .'- HttpCookies'."\n" + .'- HttpMethod'."\n" + .'- HttpPathVariables'."\n" + ."\n" + .'When Service Type is set to rpcType=255 (Kubernetes Pod Metadata), the available parameters are:'."\n" + .'- k8sPodLabel'."\n" + .'- k8sPodAnnotation'."\n" + .'- k8sPodName'."\n" + .'- k8sPodNamespace'."\n" + .'- k8sPodUID'."\n" + .'- k8sPodIp'."\n" + .'- k8sPodServiceAccount'."\n" + ."\n" + .'**Parameters for grouping rule matching**'."\n" + ."\n" + .'When Service Type is set to rpcType=0 (HTTP entry), the available parameters are:'."\n" + .'- HttpRequestParameters'."\n" + .'- HttpHeaders'."\n" + .'- HttpCookies'."\n" + .'- HttpMethod'."\n" + .'- HttpPathVariables'."\n" + ."\n" + .'When Service Type is set to rpcType=255 (Kubernetes Pod Metadata), the available parameters are:'."\n" + .'- k8sPodLabel'."\n" + .'- k8sPodAnnotation'."\n" + .'- k8sPodName'."\n" + .'- k8sPodNamespace'."\n" + .'- k8sPodUID'."\n" + .'- k8sPodIp'."\n" + .'- k8sPodServiceAccount', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetTraceAppConfig' => [ - 'summary' => 'Queries all custom settings of an application monitored by Application Monitoring, such as trace sampling settings and agent switches. This operation is applicable only to applications that are monitored by Application Monitoring. It is not applicable to applications that are monitored by Managed Service for OpenTelemetry.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2024-05-27T02:52:44.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'BindPrometheusGrafanaInstance' => [ + 'summary' => 'Binds a Grafana workspace to a Prometheus instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID (PID) of the application.'."\n" - ."\n" - .'You can use one of the following methods to obtain the PID:'."\n" - ."\n" - .'* API: Call the [ListTraceApps](~~2588008~~) operation'."\n" - .'* Console: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Application Monitoring** > **Application List**. On the Application List page, click the name of your application. The URL in the address bar contains the PID of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with an at sign (@) to obtain xxx@74xxx.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* To obtain the PID in the console, your application must be monitored by Application Monitoring rather than Managed Service for OpenTelemetry.'."\n" - ."\n" - .'* The GetTraceAppConfig operation can query only the custom settings of applications that are monitored by Application Monitoring.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a2n80plglh@745eddxxx'."\n", - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****'], + ], + [ + 'name' => 'GrafanaInstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the Grafana workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'grafana-bp1*****'], ], ], 'responses' => [ @@ -3209,260 +1198,44 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'."\n", - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****'], 'Data' => [ - 'description' => 'The custom settings of the application, which is a JSON string. For more information, see **Additional description of response parameters**.'."\n", - 'type' => 'string', - 'example' => '{"profiler":{"enable":true}}', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 2xx: The request was successful.'."\n" - .'* 3xx: The request was redirected.'."\n" - .'* 4xx: A request error occurred.'."\n" - .'* 5xx: A server error occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'enumValueTitles' => [ - '2xx' => '', - '3xx' => '', - '4xx' => '', - '5xx' => '', - ], - 'example' => '200', - ], - 'Success' => [ + 'title' => '', 'description' => 'Indicates whether the request was successful.'."\n" ."\n" - .'Valid values:'."\n" - ."\n" .'* true'."\n" .'* false'."\n", 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], + 'enumValueTitles' => ['true' => '', 'false' => ''], 'example' => 'true', ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterPidMissing', - 'errorMessage' => 'You must specify pid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The application does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'BindPrometheusGrafanaInstance', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPrometheusGrafanaInstance'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\\\n\\",\\n \\"Data\\": \\"{\\\\\\"profiler\\\\\\":{\\\\\\"enable\\\\\\":true}}\\",\\n \\"Message\\": \\"查询应用配置成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetTraceAppConfig', - 'responseParamsDescription' => 'The following tables describe the JSONPath parameter corresponding to each custom setting. Note: **Some custom settings may not be returned in the response** because they are modified at different points in time. In this case, the default values take effect.'."\n" - ."\n" - .'**Sampling settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Sampling policy|profiler.sampling.useSamplingStrategyV2|boolean|Valid values:<br />\\- `true`: adaptive sampling<br />\\- `false`: fixed-rate sampling|false|'."\n" - .'|Sampling rate|profiler.sampling.rate|double|0% to 100%<br />This setting takes effect for fixed-rate sampling.|10|'."\n" - .'|API endpoint for full collection|profiler.sampling.v2config.spanNames4FullSampleStr|String|The API endpoint whose trace data is collected. Separate multiple values with commas (,).|""|'."\n" - .'|API endpoint prefix for full collection|profiler.sampling.v2config.spanNamePrefixes4FullSampleStr|String|The prefix of the API endpoint whose trace data is collected.|""|'."\n" - .'|API endpoint suffix for full collection|profiler.sampling.v2config.spanNameSuffixes4FullSampleStr|String|The suffix of the API endpoint whose trace data is collected.|""|'."\n" - ."\n" - .'**Agent switch settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Application Monitoring switch|profiler.enable|boolean|Valid values:<br />\\- `true`: enables Application Monitoring<br />\\- `false`: disables Application Monitoring|true|'."\n" - .'|Dubbo plug-in switch|profiler.dubbo.enable|boolean|Valid values:<br />\\- `true`: enables the Dubbo plug-in<br />\\- `false`: disables the Dubbo plug-in|true|'."\n" - .'|MongoDB plug-in switch|profiler.mongodb.enable|boolean|Valid values:<br />\\- `true`: enables the MongoDB plug-in<br />\\- `false`: disables the MongoDB plug-in|true|'."\n" - .'|HSF plug-in switch|profiler.hsf.enable|boolean|Valid values:<br />\\- `true`: enables the HSF plug-in<br />\\- `false`: disables the HSF plug-in|true|'."\n" - .'|HttpClient 3 plug-in switch|profiler.httpclient3.enable|boolean|Valid values:<br />\\- `true`: enables the HttpClient 3 plug-in<br />\\- `false`: disables the HttpClient 3 plug-in|true|'."\n" - .'|HttpClient 4 plug-in switch|profiler.httpclient4.enable|boolean|Valid values:<br />\\- `true`: enables the HttpClient 4 plug-in<br />\\- `false`: disables the HttpClient 4 plug-in|true|'."\n" - .'|JDK HTTP plug-in switch|profiler.jdkhttp.enable|boolean|Valid values:<br />\\- `true`: enables the JDK HTTP plug-in<br />\\- `false`: disables the JDK HTTP plug-in|true|'."\n" - .'|Jetty plug-in switch|profiler.jetty.enable|boolean|Valid values:<br />\\- `true`: enables the Jetty plug-in<br />\\- `false`: disables the Jetty plug-in|true|'."\n" - .'|MyBatis plug-in switch|profiler.mybatis.enable|boolean|Valid values:<br />\\- `true`: enables the MyBatis plug-in<br />\\- `false`: disables the MyBatis plug-in|true|'."\n" - .'|MySQL plug-in switch|profiler.mysql.enable|boolean|Valid values:<br />\\- `true`: enables the MySQL plug-in<br />\\- `false`: disables the MySQL plug-in|true|'."\n" - .'|OkHttp plug-in switch|profiler.okhttp.enable|boolean|Valid values:<br />\\- `true`: enables the OkHttp plug-in<br />\\- `false`: disables the OkHttp plug-in|true|'."\n" - .'|Oracle plug-in switch|profiler.oracle.enable|boolean|Valid values:<br />\\- `true`: enables the Oracle plug-in<br />\\- `false`: disables the Oracle plug-in|true|'."\n" - .'|PostgreSQL plug-in switch|profiler.postgresql.enable|boolean|Valid values:<br />\\- `true`: enables the PostgreSQL plug-in<br />\\- `false`: disables the PostgreSQL plug-in|true|'."\n" - .'|Redis plug-in switch|profiler.redis.enable|boolean|Valid values:<br />\\- `true`: enables the Redis plug-in<br />\\- `false`: disables the Redis plug-in|true|'."\n" - .'|Spring plug-in switch|profiler.spring.enable|boolean|Valid values:<br />\\- `true`: enables the Spring plug-in<br />\\- `false`: disables the Spring plug-in|true|'."\n" - .'|Spring Boot plug-in switch|profiler.springboot.enable|boolean|Valid values:<br />\\- `true`: enables the Spring Boot plug-in<br />\\- `false`: disables the Spring Boot plug-in|true|'."\n" - .'|Tomcat plug-in switch|profiler.tomcat.enable|boolean|Valid values:<br />\\- `true`: enables the Tomcat plug-in<br />\\- `false`: disables the Tomcat plug-in|true|'."\n" - .'|Lettuce plug-in switch|profiler.lettuce.enable|boolean|Valid values:<br />\\- `true`: enables the Lettuce plug-in<br />\\- `false`: disables the Lettuce plug-in|true|'."\n" - .'|gRPC plug-in switch|profiler.grpc.enable|boolean|Valid values:<br />\\- `true`: enables the gRPC plug-in<br />\\- `false`: disables the gRPC plug-in|true|'."\n" - .'|Thrift plug-in switch|profiler.thrift.enable|boolean|Valid values:<br />\\- `true`: enables the Thrift plug-in<br />\\- `false`: disables the Thrift plug-in|true|'."\n" - .'|Hystrix plug-in switch|profiler.hystrix.enable|boolean|Valid values:<br />\\- `true`: enables the Hystrix plug-in<br />\\- `false`: disables the Hystrix plug-in|true|'."\n" - .'|RxJava plug-in switch|profiler.rxjava.enable|boolean|Valid values:<br />\\- `true`: enables the RxJava plug-in<br />\\- `false`: disables the RxJava plug-in|true|'."\n" - .'|Memcached plug-in switch|profiler.memcached.enable|boolean|Valid values:<br />\\- `true`: enables the Memcached plug-in<br />\\- `false`: disables the Memcached plug-in|true|'."\n" - .'|Druid plug-in switch|profiler.jdbc.druid.enable|boolean|Valid values:<br />\\- `true`: enables the Druid plug-in<br />\\- `false`: disables the Druid plug-in|true|'."\n" - .'|WebLogic plug-in switch|profiler.weblogic.enable|boolean|Valid values:<br />\\- `true`: enables the WebLogic plug-in<br />\\- `false`: disables the WebLogic plug-in|true|'."\n" - .'|ElasticJob plug-in switch|profiler.elasticjob.enable|boolean|Valid values:<br />\\- `true`: enables the ElasticJob plug-in<br />\\- `false`: disables the ElasticJob plug-in|true|'."\n" - .'|Elasticsearch plug-in switch|profiler.elasticsearch.enable|boolean|Valid values:<br />\\- `true`: enables the Elasticsearch plug-in<br />\\- `false`: disables the Elasticsearch plug-in|true|'."\n" - .'|HikariCP plug-in switch|profiler.jdbc.hikaricp.enable|boolean|Valid values:<br />\\- `true`: enables the HikariCP plug-in<br />\\- `false`: disables the HikariCP plug-in|true|'."\n" - .'|InfluxDB plug-in switch|profiler.influxdb.enable|boolean|Valid values:<br />\\- `true`: enables the InfluxDB plug-in<br />\\- `false`: disables the InfluxDB plug-in|true|'."\n" - .'|Kafka plug-in switch|profiler.kafka.enable|boolean|Valid values:<br />\\- `true`: enables the Kafka plug-in<br />\\- `false`: disables the Kafka plug-in|true|'."\n" - .'|Netty plug-in switch|profiler.netty.enable|boolean|Valid values:<br />\\- `true`: enables the Netty plug-in<br />\\- `false`: disables the Netty plug-in|true|'."\n" - .'|Play plug-in switch|profiler.play.enable|boolean|Valid values:<br />\\- `true`: enables the Play plug-in<br />\\- `false`: disables the Play plug-in|true|'."\n" - .'|Reactor plug-in switch|profiler.reactor.enable|boolean|Valid values:<br />\\- `true`: enables the Reactor plug-in<br />\\- `false`: disables the Reactor plug-in|true|'."\n" - .'|Redisson plug-in switch|profiler.redis.redisson.enable|boolean|Valid values:<br />\\- `true`: enables the Redisson plug-in<br />\\- `false`: disables the Redisson plug-in|true|'."\n" - .'|RabbitMQ plug-in switch|profiler.rabbitmq.client.enable|boolean|Valid values:<br />\\- `true`: enables the RabbitMQ plug-in<br />\\- `false`: disables the RabbitMQ plug-in|true|'."\n" - .'|SchedulerX plug-in switch|profiler.schedulerx.enable|boolean|Valid values:<br />\\- `true`: enables the SchedulerX plug-in<br />\\- `false`: disables the SchedulerX plug-in|true|'."\n" - .'|Undertow plug-in switch|profiler.undertow.enable|boolean|Valid values:<br />\\- `true`: enables the Undertow plug-in<br />\\- `false`: disables the Undertow plug-in|true|'."\n" - .'|Vert.x plug-in switch|profiler.vertx.enable|boolean|Valid values:<br />\\- `true`: enables the Vert.x plug-in<br />\\- `false`: disables the Vert.x plug-in|true|'."\n" - .'|XXL-JOB plug-in switch|profiler.xxljob.enable|boolean|Valid values:<br />\\- `true`: enables the XXL-JOB plug-in<br />\\- `false`: disables the XXL-JOB plug-in|true|'."\n" - .'|ONS Client plug-in switch|profiler.onsclient.enable|boolean|Valid values:<br />\\- `true`: enables the ONS Client plug-in<br />\\- `false`: disables the ONS Client plug-in|true|'."\n" - .'|Quartz plug-in switch|profiler.quartz.enable|boolean|Valid values:<br />\\- `true`: enables the Quartz plug-in<br />\\- `false`: disables the Quartz plug-in|true|'."\n" - .'|Servlet plug-in switch|profiler.servlet.enable|boolean|Valid values:<br />\\- `true`: enables the Servlet plug-in<br />\\- `false`: disables the Servlet plug-in|true|'."\n" - .'|Liberty plug-in switch|profiler.liberty.enable|boolean|Valid values:<br />\\- `true`: enables the Liberty plug-in<br />\\- `false`: disables the Liberty plug-in|true|'."\n" - .'|Akka plug-in switch|profiler.akka.enable|boolean|Valid values:<br />\\- `true`: enables the Akka plug-in<br />\\- `false`: disables the Akka plug-in|true|'."\n" - .'|Cassandra plug-in switch|profiler.cassandra.enable|boolean|Valid values:<br />\\- `true`: enables the Cassandra plug-in<br />\\- `false`: disables the Cassandra plug-in|true|'."\n" - .'|OpenTelemetry plug-in switch|profiler.opentelemetry.enable|boolean|Valid values:<br />\\- `true`: enables the OpenTelemetry plug-in<br />\\- `false`: disables the OpenTelemetry plug-in|true|'."\n" - .'|Google HTTP Client plug-in switch|profiler.googlehttpclient.enable|boolean|Valid values:<br />\\- `true`: enables the Google HTTP Client plug-in<br />\\- `false`: disables the Google HTTP Client plug-in|true|'."\n" - .'|Ning plug-in switch|profiler.ning.asynchttpclient.enable|boolean|Valid values:<br />\\- `true`: enables the Ning plug-in<br />\\- `false`: disables the Ning plug-in|true|'."\n" - ."\n" - .'**Thread profiling settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Thread profiling switch|profiler.tprof.enableJvmThreadStatistic|boolean|Valid values:<br />\\- `true`: enables thread profiling<br />\\- `false`: disables thread profiling|true|'."\n" - .'|Switch for periodically saving local method stacks|profiler.tprof.enableThreadStackRecorder|boolean|Valid values:<br />\\- `true`: enables periodic storage of local method stacks<br />\\- `false`: disables periodic storage of local method stacks|false|'."\n" - .'|Threshold for time-consuming calls|profiler.tprof. threadProfilerSlowInteractionRt|int|Unit: ms. If the duration exceeds the threshold, the local method stack is automatically saved.|2000|'."\n" - ."\n" - .'**Application log association settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Log source|profiler.logSource|String|Valid values:<br />\\- `sls`: Simple Log Service|sls|'."\n" - .'|Switch for automatically associating business logs with trace IDs|profiler.logging.enable|boolean|Valid values:<br />\\- `true`: enables the association of business logs with trace IDs<br />\\- `false`: disables the association of business logs with trace IDs|true|'."\n" - .'|Switch for automatically filling in trace IDs in logs|profiler.logging.injectTraceId2Log.enable|boolean|Valid values:<br />\\- `true`: enables the automatic filling of span IDs in logs<br />\\- `false`: disables the automatic filling of span IDs in logs<br />This setting takes effect for ARMS agents V4.1.6 or later.|true|'."\n" - .'|Switch for automatically filling in span IDs in logs|profiler.logging.injectSpanId2Log.enable|boolean|Valid values:<br />\\- `true`: enables the automatic filling of span IDs in logs<br />\\- `false`: disables the automatic filling of span IDs in logs<br />This setting takes effect for ARMS agents V4.1.6 or later.|true|'."\n" - .'|Associate Simple Log Service - Region|profiler.SLS.regionId|String|The region where the associated log source resides.|""|'."\n" - .'|Associate Simple Log Service - Project|profiler.SLS.project|String|The project to which the associated log source belongs.|""|'."\n" - .'|Associate Simple Log Service - Logstore|profiler.SLS.logStore|String|The Logstore to which the associated log source belongs.|""|'."\n" - .'|Associate Simple Log Service - Associated index|profiler.SLS.index|String|The index of the associated log source.|""|'."\n" - ."\n" - .'**URL convergence settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Convergence URL|profiler.convergence.enable|boolean|Valid values:<br />\\- `true`: enables the URL convergence feature<br />\\- `false`: disables the URL convergence feature|true|'."\n" - .'|Convergence threshold|profiler.convergence.minServerSize|long|URLs are converged when the threshold is reached.|1000|'."\n" - .'|Convergence rule|profiler.convergence.pattern|String|Each rule is a regular expression.<br />Example: `/service/(.*?)/demo`.<br />Separate multiple rules with commas (,).|""|'."\n" - ."\n" - .'**Arthas settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Arthas switch|profiler.arthas.enable|boolean|Valid values:<br />\\- `true`: enables the Arthas diagnostics feature<br />\\- `false`: disables the Arthas diagnostics feature|false|'."\n" - .'|IP address effective in real time|profiler.arthas.enableIps|string|The IP addresses for which the Arthas diagnostics feature is enabled. Separate multiple IP addresses with commas (,).<br />**An empty string indicates that the Arthas diagnostics feature is enabled for all IP addresses.**|""|'."\n" - ."\n" - .'**Continuous profiling settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Switch|profiler.cp.enable|boolean|Valid values:<br />\\- `true`: enables the continuous profiling feature<br />\\- `false`: disables the continuous profiling feature<br />\\* After the switch is turned on, two configuration modes are available, as shown in the following table.|false|'."\n" - .'|CPU hotspot|profiler.cp.cpuEnable|boolean|Valid values:<br />\\- `true`: enables the CPU hotspot feature<br />\\- `false`: disables the CPU hotspot feature|false|'."\n" - .'|Memory hotspot|profiler.cp.allocEnable|boolean|Valid values:<br />\\- `true`: enables the memory hotspot feature<br />\\- `false`: disables the memory hotspot feature|false|'."\n" - .'|Code hotspot|profiler.cp.wallClockEnable|boolean|Valid values:<br />\\- `true`: enables the code hotspot feature<br />\\- `false`: disables the code hotspot feature|false|'."\n" - ."\n" - .'|||||'."\n" - .'|---|---|---|---|'."\n" - .'|Mode|Key|Field|Value|'."\n" - .'|IP address whitelist|cp.allowIPs|IP address whitelist|The IP address of the instances for which continuous profiling is enabled. Separate multiple values with commas (,).<br />Example: 192.168.0.1,192.168.0.2|'."\n" - .'|cp.allowNetwork|CIDR block|Specify an empty string. Otherwise, this feature does not work properly.|'."\n" - .'|CIDR block|cp.allowIPs|IP address whitelist|Specify an empty string. Otherwise, this feature does not work properly.|'."\n" - .'|cp.allowNetwork|CIDR block|The CIDR block of the instances for which continuous profiling is enabled.<br />Example: 192.168.2.0/24/24|'."\n" - ."\n" - .'**Data masking settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Data masking switch|profiler.sanitizer.enable|boolean|Valid values:<br />\\- `true`: enables the data masking feature<br />\\- `false`: disables the data masking feature|true|'."\n" - .'|Data masking rule|profiler.sanitizer.keys|String|Case-insensitive matching of sensitive keys containing specified terms. Separate multiple IP addresses with commas (,).|true|'."\n" - ."\n" - .'**Operation call settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Slow request threshold|profiler.thresholds.interface|long|Unit: ms. If the response time is longer than this threshold, the request is marked as slow.|500|'."\n" - .'|Exception whitelist|profiler.exception.whitelist|String|Specify regular expressions for exception names, where matching exceptions are excluded from statistical charts. Separate multiple rules with commas (,).|""|'."\n" - .'|Exception filtering through parent class inheritance|profiler.exception.filterByParentClass|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature<br />After the feature is enabled, you can configure parent exceptions in exception filtering.<br />This setting takes effect for ARMS agents V4.1.6 or later.|true|'."\n" - .'|HTTP status code whitelist|profiler.error.skip|String|The HTTP status codes you want to ignore. Separate multiple values with commas (,).|""|'."\n" - .'|Filtering of invalid API calls|profiler.defined.excludeurl|String|The API calls that are ignored. Each rule is a regular expression. Separate multiple values with commas (,).|/\\*\\*/\\*.jpg,/\\*\\*/\\*.png,/\\*\\*/\\*.js,<br />/\\*\\*/\\*.jpeg,/\\*\\*/\\*.pdf,/\\*\\*/\\*.xlsx,<br />/\\*\\*/\\*.txt,/\\*\\*/\\*.docs,/\\*\\*/\\*.gif,<br />/\\*\\*/\\*.csv|'."\n" - ."\n" - .'**Database call settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Slow SQL query threshold|profiler.thresholds.sql|long|Unit: ms. If the duration of an SQL query exceeds the threshold, the query is marked as slow.|500|'."\n" - .'|Maximum SQL capture retention length|profiler.callsql.maxLength|long|If the value of an SQL statement exceeds the threshold, the SQL statement is truncated.|1024|'."\n" - .'|Switch for displaying bound variables in SQL statements|profiler.jdbc.tracesqlbindvalue|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature<br />If you turn on this switch, the variable values bound to the PrepareStatement parameter are captured and displayed on the page. **Only MySQL is supported.**|false|'."\n" - .'|Switch for displaying constants in SQL statements|profiler.jdbc. tracesqlraw|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature<br />After the feature is enabled, raw SQL statements are captured.|false|'."\n" - ."\n" - .'**Tracing protocol settings**'."\n" - ."\n" - .'****Note: The context propagation protocol settings take effect only for ARMS agents V4.1.x or later.****'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Context propagation protocol|profiler.trace.protocol.name|String|Valid values:<br />\\- `Unset`: not set<br />\\- `W3C`: OpenTelemetry W3C<br />\\- `SkyWalking`<br />\\- `Zipkin`: Zipkin B3<br />\\- `Jaeger`<br />\\- `EagleEye`|Unset|'."\n" - .'|Context propagation mode|profiler.trace.protocol. strategy|String|Valid values:<br />\\- `PriorityUse`<br />\\- `ForceUse`|PriorityUse|'."\n" - ."\n" - .'**Advanced settings**'."\n" - ."\n" - .'|Setting|JSONPath|Type|Description|Default value|'."\n" - .'|---|---|---|---|---|'."\n" - .'|Maximum number of traces collected by the agent per second|profiler.thresholds.limit|int|A protective measure to ensure business operations are not impacted by trace collection in high traffic.|100|'."\n" - .'|Method stack retention limit|profiler.callstack.maxLength|int|If the length of a method stack exceeds the threshold, the method stack is truncated during collection.<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|128|'."\n" - .'|Stack depth for same-type exceptions|profiler.exception.stacktrace|int|The stack depth based on which the system identifies the same type of exceptions.|2|'."\n" - .'|Maximum display length of request parameters|profiler.param.maxLength|int|The maximum display length of request parameters.|512|'."\n" - .'|Custom RabbitMQ consumer|profiler.rabbitmq.client.consumer.classes|String|The fully qualified class names of RabbitMQ consumers. Separate multiple consumers with commas (,).<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|""|'."\n" - .'|Custom Kafka consumption method|profiler.kafka.consumer.entryPoint|String|The consumption method of the Kafka consumer.<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|""|'."\n" - .'|Switch for automatically propagating context when Kafka sends messages|profiler.kafka.enableInjectKafkaHeaders|boolean|Specifies whether to automatically inject tracing headers to Kafka messages to associate the sending trace with the consumption trace.<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|false|'."\n" - .'|Package name for asynchronous propagation|profiler.thread.match.package|String|When a Runnable, Callable, Supplier under the specified package is created, the trace context is automatically captured and propagated to the new thread. Separate multiple package names with commas (,).<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|""|'."\n" - .'|Inclusion of trace IDs in an HTTP response|profiler.responseInject.enable|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature|false|', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": true,\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', ], - 'DeleteTraceApp' => [ - 'summary' => 'Deletes an application based on a specified process identifier (PID) and application type.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'BlockAlarmNotification' => [ + 'summary' => 'Blocks alert notifications. After an alert is blocked, no more notifications are sent within the specified time range.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3470,98 +1243,29 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application that you want to delete. You can call the SearchTraceAppByName operation to query the application ID. For more information, see [SearchTraceAppByName](~~130676~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '5406**', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the application is located.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'AlarmId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application that you want to delete. You can call the SearchTraceAppByName operation to query the application type. For more information, see [SearchTraceAppByName](~~130676~~). Valid values:'."\n" - ."\n" - .'* `TRACE`: Application Monitoring'."\n" - .'* `RETCODE`: frontend monitoring'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TRACE', - ], + 'schema' => ['description' => 'The ID of the alert.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '133', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'Timeout', 'in' => 'query', - 'schema' => [ - 'description' => 'The PID of the application. For more information about how to query the PID, see [QueryMetricByPage](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '9w0sc5gxxz@edcsd447c2f****', - ], + 'schema' => ['description' => 'The number of seconds that elapse before alert notifications are blocked. Unit: seconds.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '180', 'title' => ''], ], [ - 'name' => 'DeleteReason', + 'name' => 'HandlerId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The reason(s) to delete application.', - 'type' => 'object', - 'properties' => [ - 'Remark' => [ - 'description' => 'Additional remarks when none of the reasons for removal provided are met.', - 'type' => 'string', - 'required' => false, - 'example' => 'The business scenario cannot be satisfied.', - ], - 'ReasonIds' => [ - 'description' => 'Reasons Ids.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the reason for deletion.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Name' => [ - 'description' => 'A description of the reason for removal.', - 'type' => 'string', - 'required' => false, - 'example' => 'The function is not perfect, and the root cause of the problem cannot be located.', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the alert handler.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2044049', 'title' => ''], ], ], 'responses' => [ @@ -3569,76 +1273,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The response in JSON format, including the HTTP status code, error code, response message, and trace ID.'."\n", - 'type' => 'string', - 'example' => '"{\\\\"code\\\\":200,\\\\"data\\\\":\\\\"{\\\\\\\\\\"code\\\\\\\\\\":200,\\\\\\\\\\"data\\\\\\\\\\":true,\\\\\\\\\\"errorCode\\\\\\\\\\":\\\\\\\\\\"The application is deleted\\\\\\\\\\",\\\\\\\\\\"message\\\\\\\\\\":\\\\\\\\\\"The application is deleted\\\\\\\\\\",\\\\\\\\\\"success\\\\\\\\\\":true,\\\\\\\\\\"traceId\\\\\\\\\\":\\\\\\\\\\"0bc0594d15954826692915817e\\*\\*\\*\\*\\\\\\\\\\"}\\\\",\\\\"errorCode\\\\":\\\\"The application is deleted\\\\",\\\\"message\\\\":\\\\"The application is deleted\\\\",\\\\"success\\\\":true,\\\\"traceId\\\\":\\\\"0ab2646915954826692568137d\\*\\*\\*\\*\\\\"}'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'true: The request was successful.'."\n" - ."\n" - .'false: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', 'title' => ''], + 'Result' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 403 => [ - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], - ], - 406 => [ - [ - 'errorCode' => 'AgentNotUninstalled', - 'errorMessage' => 'agent not uninstalled.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'BlockAlarmNotification', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlockAlarmNotification'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"0bc0594d15954826692915817e****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0ab2646915954826692568137d****\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteTraceAppResponse>\\n\\t<RequestId>46355DD8-FC56-40C5-BFC6-269DE4F9****</RequestId>\\n\\t<Data>{\\"code\\":200,\\"data\\":\\"{\\\\\\"code\\\\\\":200,\\\\\\"data\\\\\\":true,\\\\\\"errorCode\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"message\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"success\\\\\\":true,\\\\\\"traceId\\\\\\":\\\\\\"0bc0594d15954826692915817e****\\\\\\"}\\",\\"errorCode\\":\\"删除应用成功\\",\\"message\\":\\"删除应用成功\\",\\"success\\":true,\\"traceId\\":\\"0ab2646915954826692568137d****\\"}</Data>\\n</DeleteTraceAppResponse>","errorExample":""}]', - 'title' => 'DeleteTraceApp', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', ], - 'QueryReleaseMetric' => [ - 'summary' => 'Queries the metrics that are provided for different versions of a specified Enterprise Distributed Application Service (EDAS) or Kubernetes application.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ChangeAlarmSeverity' => [ + 'summary' => 'Modifies the severity level of an alert.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3646,92 +1313,36 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Pid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Enterprise Distributed Application Service (EDAS) or Kubernetes application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '8b46d03f-5947-449d-90fd-3a96c2******', - ], - ], - [ - 'name' => 'ChangeOrderId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the change order.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'a341a2f2-ed07-4257-aae9-dfb1be******', - ], - ], - [ - 'name' => 'ReleaseStartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start time of the version release.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1632798686692', - ], - ], - [ - 'name' => 'ReleaseEndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end time of the version release.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1632798718632', - ], - ], - [ - 'name' => 'CreateTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time when the change order was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1634005438000', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Service', + 'name' => 'AlarmId', 'in' => 'query', - 'schema' => [ - 'description' => 'The service that you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'clothservice', - ], + 'schema' => ['description' => 'The ID of the alert.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '184723093', 'title' => ''], ], [ - 'name' => 'MetricType', + 'name' => 'Severity', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the metric that you want to query.'."\n", + 'description' => 'The severity level of the alert. Valid values: P1, P2, P3, and P4. P4 indicates the lowest severity, whereas P1 indicates the highest severity.'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'SystemContrast', + 'required' => true, + 'example' => 'P1', + 'enum' => ['P1', 'P2', 'P3', 'P4'], + 'title' => '', ], ], [ - 'name' => 'ProxyUserId', + 'name' => 'HandlerId', 'in' => 'query', - 'schema' => [ - 'description' => 'This parameter is not in use.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The ID of the handler.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2046076', 'title' => ''], ], ], 'responses' => [ @@ -3739,42 +1350,39 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The returned metric data.'."\n", - 'type' => 'string', - 'example' => '{"data":{"SystemCpuUser":{"all":[{"date":1632798718000,"val":4.3277,"dim":"SystemCpuUser"},{"date":1632798733000,"val":8.1091,"dim":"SystemCpuUser"}]},"SystemMemUtil":{"all":[{"date":1632798718000,"val":73.4227,"dim":"SystemMemUtil"},{"date":1632798733000,"val":93.0977,"dim":"SystemMemUtil"}]}},"success":true}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', 'title' => ''], + 'Result' => ['description' => 'Indicates whether the severity level was modified.'."\n" + ."\n" + .'- `true`: The severity level was modified.'."\n" + .'- `false`: The severity level failed to be modified.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- true'."\n" + .'- false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'ChangeAlarmSeverity', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeAlarmSeverity'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"data\\\\\\":{\\\\\\"SystemCpuUser\\\\\\":{\\\\\\"all\\\\\\":[{\\\\\\"date\\\\\\":1632798718000,\\\\\\"val\\\\\\":4.3277,\\\\\\"dim\\\\\\":\\\\\\"SystemCpuUser\\\\\\"},{\\\\\\"date\\\\\\":1632798733000,\\\\\\"val\\\\\\":8.1091,\\\\\\"dim\\\\\\":\\\\\\"SystemCpuUser\\\\\\"}]},\\\\\\"SystemMemUtil\\\\\\":{\\\\\\"all\\\\\\":[{\\\\\\"date\\\\\\":1632798718000,\\\\\\"val\\\\\\":73.4227,\\\\\\"dim\\\\\\":\\\\\\"SystemMemUtil\\\\\\"},{\\\\\\"date\\\\\\":1632798733000,\\\\\\"val\\\\\\":93.0977,\\\\\\"dim\\\\\\":\\\\\\"SystemMemUtil\\\\\\"}]}},\\\\\\"success\\\\\\":true}\\",\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\"\\n}","type":"json"}]', - 'title' => 'QueryReleaseMetric', ], - 'ListTraceApps' => [ - 'summary' => 'Queries all Application Monitoring tasks in a specified region.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ChangeResourceGroup' => [ + 'summary' => 'Moves a resource to a specific resource group.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -3782,276 +1390,72 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], - ], - [ - 'name' => 'Tags', + 'name' => 'ResourceId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ggxw4lnjuz@cfd34a78f******', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'NewResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => 'The ID of the new resource group. You can view the available resource groups in the Resource Management console.'."\n", 'type' => 'string', 'required' => true, 'example' => 'rg-aek2vezare****', 'title' => ''], ], [ - 'name' => 'AppType', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application that is associated with the alert rule. Valid values:'."\n" - ."\n" - .'- TRACE: Application Monitoring'."\n" - .'- EBPF: Application Monitoring eBPF Edition', - 'type' => 'string', - 'required' => false, - 'example' => 'TRACE', - ], + 'schema' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'required' => false, 'example' => 'APPLICATION', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* `2XX`: The request is successful.'."\n" - .'* `3XX`: A redirection message is returned.'."\n" - .'* `4XX`: The request is invalid.'."\n" - .'* `5XX`: A server error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request parameters are invalid.'."\n", - 'type' => 'string', - 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', - ], - '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', - ], - 'TraceApps' => [ - 'description' => 'The list of Application Monitoring tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'* `TRACE`: Application Monitoring'."\n" - .'* `RETCODE`: Browser Monitoring'."\n", - 'type' => 'string', - 'example' => 'TRACE', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test-app', - ], - 'UpdateTime' => [ - 'description' => 'The time when the monitoring task was updated. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1529667762000', - ], - 'Show' => [ - 'description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'description' => 'The time when the monitoring task was created. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1529667762000', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'a5f9bdeb-2627-4dbe-9247-****', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Labels' => [ - 'description' => 'The labels of the application.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the application label.'."\n", - 'type' => 'string', - 'example' => 'prod', - ], - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - ], - 'description' => '', - ], - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'Resource group'."\n", - ], - 'Source' => [ - 'description' => 'The application source.'."\n", - 'type' => 'string', - 'example' => 'ACK', - ], - 'WorkloadName' => [ - 'description' => 'The name of the workload.', - 'type' => 'string', - 'example' => 'nginx-deployment ', - ], - 'WorkloadKind' => [ - 'description' => 'The type of the workload.', - 'type' => 'string', - 'example' => 'Deployment', - ], - 'Namespace' => [ - 'description' => 'The namespace.', - 'type' => 'string', - 'example' => 'default', - ], - 'ClusterId' => [ - 'description' => 'The cluster ID.', - 'type' => 'string', - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], - 'Language' => [ - 'description' => 'The language.', - 'type' => 'string', - 'example' => 'PHP', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****'], + 'Data' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'ResourceId' => ['description' => 'The resource ID.'."\n", 'type' => 'string', 'example' => 'ggxw4lnjuz@cfd34a78f******', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-aek2vezare****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code or error code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => '必选参数不能为空', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\",\\n \\"Data\\": {\\n \\"ResourceId\\": \\"ggxw4lnjuz@cfd34a78f******\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + 'title' => 'ChangeResourceGroup', + 'changeSet' => [ + ['createdAt' => '2023-12-14T07:43:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-27T07:22:17.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.\\",\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Success\\": true,\\n \\"TraceApps\\": [\\n {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"UpdateTime\\": 1529667762000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1529667762000,\\n \\"Pid\\": \\"a5f9bdeb-2627-4dbe-9247-****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"prod\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Source\\": \\"ACK\\",\\n \\"WorkloadName\\": \\"nginx-deployment \\",\\n \\"WorkloadKind\\": \\"Deployment\\",\\n \\"Namespace\\": \\"default\\",\\n \\"ClusterId\\": \\"cc7a37ee31aea4ed1a059eff8034b****\\",\\n \\"Language\\": \\"PHP\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTraceAppsResponse>\\n\\t<TraceApps>\\n\\t\\t<Type>TRACE</Type>\\n\\t\\t<AppId>123</AppId>\\n\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t<CreateTime>1571865746000</CreateTime>\\n\\t\\t<UpdateTime>1571865746000</UpdateTime>\\n\\t\\t<Pid>a5f9bdeb-2627-4dbe-9247-****</Pid>\\n\\t\\t<Show>true</Show>\\n\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t<AppName>test-app</AppName>\\n\\t</TraceApps>\\n\\t<TraceApps>\\n\\t\\t<Type>TRACE</Type>\\n\\t\\t<AppId>234</AppId>\\n\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t<CreateTime>1572401289000</CreateTime>\\n\\t\\t<UpdateTime>1572401289000</UpdateTime>\\n\\t\\t<Pid>be1f9a33-9c8e-445e-9115-****</Pid>\\n\\t\\t<Show>true</Show>\\n\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t<AppName>test-app2</AppName>\\n\\t</TraceApps>\\n\\t<TraceApps>\\n\\t\\t<Type>TRACE</Type>\\n\\t\\t<AppId>345</AppId>\\n\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t<CreateTime>1576338375000</CreateTime>\\n\\t\\t<UpdateTime>1576338375000</UpdateTime>\\n\\t\\t<Pid>e04391e2-a7e0-4fbe-9987****</Pid>\\n\\t\\t<Show>true</Show>\\n\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t<AppName>test-app3</AppName>\\n\\t</TraceApps>\\n\\t<RequestId>40B10E04-81E8-4643-970D-F1B38F2E****</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</ListTraceAppsResponse>","errorExample":""}]', - 'title' => 'ListTraceApps', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'ramActions' => [], ], - 'SearchTraceAppByName' => [ - 'summary' => 'Queries Application Monitoring tasks by application name.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CheckCommercialStatus' => [ + 'summary' => 'Checks the commercial activation status of a product.', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -4059,189 +1463,75 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'TraceAppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n" - ."\n" - .'> If you do not specify this parameter, all application monitoring tasks in the specified region are queried.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test-app', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Default value: ap-southeast-1.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'Service', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, + 'description' => 'The sub-product type. Valid values:'."\n" + ."\n" + .'- apm: Application Monitoring'."\n" + .'- rum: Real User Monitoring'."\n" + .'- prometheus: Managed Service for Prometheus'."\n" + .'- xtrace: Managed Service for OpenTelemetry', + 'enumValueTitles' => ['xtrace' => 'xtrace', 'prometheus' => 'prometheus', 'rum' => 'rum', 'apm' => 'apm'], + 'type' => 'string', + 'required' => true, + 'example' => 'apm', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - 'TraceApps' => [ - 'description' => 'The information about the monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'* `TRACE`: Application Monitoring'."\n" - .'* `RETCODE`: Browser Monitoring'."\n", - 'type' => 'string', - 'example' => 'TRACE', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test-app', - ], - 'UpdateTime' => [ - 'description' => 'The timestamp generated when the task information was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593486786000', - ], - 'Show' => [ - 'description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'description' => 'The timestamp generated when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1593486786000', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'a5f9bdeb-2627-4dbe-9247-****', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Labels' => [ - 'description' => 'The aliases of the application.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alias of the application.'."\n", - 'type' => 'string', - 'example' => 'prod', - ], - ], - 'Tags' => [ - 'description' => 'A list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - ], - ], - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****'], + 'Data' => ['description' => 'The response struct.', 'type' => 'string', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"TraceApps\\": [\\n {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"UpdateTime\\": 1593486786000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1593486786000,\\n \\"Pid\\": \\"a5f9bdeb-2627-4dbe-9247-****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"prod\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'SearchTraceAppByName', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchTraceAppByPage' => [ - 'summary' => 'Queries Application Monitoring tasks by page.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Check product commercial activation status', + 'description' => 'Retrieves the commercial activation status of a product.', + 'changeSet' => [ + ['createdAt' => '2024-06-20T02:56:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-21T02:18:58.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CheckCommercialStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Data\\": \\"True\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CheckServiceStatus' => [ + 'summary' => 'Checks the status of a service in the current cluster, such as whether the service is activated and whether the payment is overdue.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -4251,720 +1541,329 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '44423', + 'abilityTreeNodes' => ['FEATUREarms7LDEBN'], ], 'parameters' => [ [ - 'name' => 'TraceAppName', + 'name' => 'SvcCode', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The service code of an Alibaba Cloud service. The service code of Managed Service for Prometheus is prometheus.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'prometheus', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of the page to return. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true.'."\n" + .'* false.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to find logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '5710C923-AD09-4293-9E11-DCBE3D15F8D4', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"5710C923-AD09-4293-9E11-DCBE3D15F8D4\\"\\n}","type":"json"}]', + 'title' => 'CheckServiceStatus', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceStatus'], + ], + ], + ], + 'ClaimAlarm' => [ + 'summary' => 'Claims an alert. This operation can be used together with escalation policies. When multiple handlers are involved in alert management, each handler can call this operation to claim alerts. After an alert is claimed, the alert enters the Being Processed state.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: `10`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '10', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'create'], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'AlarmId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The ID of the alert.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '184723093', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'HandlerId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'A list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The ID of the handler.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2046076', 'title' => ''], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4B446DF2-3DDD-4B5B-8E3F-D5225120****', - ], - 'PageBean' => [ - 'description' => 'The information about the array object.'."\n", - 'type' => 'object', - 'properties' => [ - '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', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'TraceApps' => [ - 'description' => 'The information about the monitoring task.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'* `TRACE`: Application Monitoring'."\n" - .'* `RETCODE`: Browser Monitoring'."\n", - 'type' => 'string', - 'example' => 'TRACE', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'test-app', - ], - 'UpdateTime' => [ - 'description' => 'The timestamp generated when the task information was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531291867000', - ], - 'Show' => [ - 'description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" - ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CreateTime' => [ - 'description' => 'The timestamp generated when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1531291867000', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Labels' => [ - 'description' => 'The aliases of the application.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The alias of the application.'."\n", - 'type' => 'string', - 'example' => 'prod', - ], - ], - 'Tags' => [ - 'description' => 'A list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], - ], - ], - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', 'title' => ''], + 'Result' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'`true`'."\n" + ."\n" + .'`false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4B446DF2-3DDD-4B5B-8E3F-D5225120****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"TraceApps\\": [\\n {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"UpdateTime\\": 1531291867000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1531291867000,\\n \\"Pid\\": \\"atc889zkcf@d8deedfa9bf****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"prod\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchTraceAppByPageResponse>\\n\\t<PageBean>\\n\\t\\t<TotalCount>3</TotalCount>\\n\\t\\t<TraceApps>\\n\\t\\t\\t<Type>TRACE</Type>\\n\\t\\t\\t<AppId>123</AppId>\\n\\t\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t\\t<CreateTime>1571865746000</CreateTime>\\n\\t\\t\\t<UpdateTime>1571865746000</UpdateTime>\\n\\t\\t\\t<Pid>b590lhguqs@50e2179afeb****</Pid>\\n\\t\\t\\t<Show>true</Show>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<AppName>test-app</AppName>\\n\\t\\t</TraceApps>\\n\\t\\t<TraceApps>\\n\\t\\t\\t<Type>TRACE</Type>\\n\\t\\t\\t<AppId>234</AppId>\\n\\t\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t\\t<CreateTime>1572401289000</CreateTime>\\n\\t\\t\\t<UpdateTime>1572401289000</UpdateTime>\\n\\t\\t\\t<Pid>b590lhguqs@b0175fb5bda****</Pid>\\n\\t\\t\\t<Show>true</Show>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<AppName>test-app2</AppName>\\n\\t\\t</TraceApps>\\n\\t\\t<TraceApps>\\n\\t\\t\\t<Type>TRACE</Type>\\n\\t\\t\\t<AppId>345</AppId>\\n\\t\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t\\t<CreateTime>1576338375000</CreateTime>\\n\\t\\t\\t<UpdateTime>1576338375000</UpdateTime>\\n\\t\\t\\t<Pid>b590lhguqs@3afb9343a31****</Pid>\\n\\t\\t\\t<Show>true</Show>\\n\\t\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t\\t<AppName>test-app3</AppName>\\n\\t\\t</TraceApps>\\n\\t\\t<PageSize>10</PageSize>\\n\\t\\t<PageNumber>1</PageNumber>\\n\\t</PageBean>\\n\\t<RequestId>4B446DF2-3DDD-4B5B-8E3F-D5225120****</RequestId>\\n</SearchTraceAppByPageResponse>","errorExample":""}]', - 'title' => 'SearchTraceAppByPage', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchTraces' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'ClaimAlarm', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ClaimAlarm'], + ], ], + ], + 'CloseAlarm' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'StartTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1595174400000', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'AlarmId', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1595210400000', - ], + 'schema' => ['description' => 'The ID of the alert.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '184723093', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Solution', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The alert solution.'."\n", 'type' => 'string', 'required' => false, 'example' => '重启修复', 'title' => ''], ], [ - 'name' => 'ServiceName', + 'name' => 'HandlerId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'arms-k8s-demo-subcomponent', - ], + 'schema' => ['description' => 'The ID of the alert handler.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2048065', 'title' => ''], ], - [ - 'name' => 'OperationName', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the traced span.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/demo/queryNotExistDB/11', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', 'title' => ''], + 'Result' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CloseAlarm', + 'summary' => 'Disables an alert. Make sure that the alert is resolved before you disable the alert. If an alert is not resolved, new alerts can be triggered even after the alert is disabled.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseAlarm'], + ], + ], + 'ramActions' => [ [ - 'name' => 'MinDuration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CloseAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'ConfigApp' => [ + 'summary' => 'Turns on or off the main switch of an ARMS agent, or queries the status of the main switch.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Reverse', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" - ."\n" - .'* `true`: sorts the query results in reverse chronological order.'."\n" - .'* `false`: sorts the query results in chronological order.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'ServiceIp', + 'name' => 'AppIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address of the host where the application resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '172.20.XX.XX', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application. Separate multiple PIDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'iioe7jcnuk@582846f37******,atc889zkcf@d8deedfa9bf******', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'Enable', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b590lhguqs@9781be0f44dXXXX', - ], + 'schema' => ['description' => 'Specifies whether to turn on or off the main switch of the ARMS agent. The monitoring stops after the switch is turned off. If you do not specify this parameter, the main switch status of the ARMS agent is queried.'."\n" + ."\n" + .'* `true`: turns on the switch'."\n" + .'* `false`: turns off the switch'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. The following system preset fields are provided:'."\n" - ."\n" - .'* serverApp: the name of the server application.'."\n" - .'* clientApp: the name of the client application.'."\n" - .'* service: the name of the operation.'."\n" - .'* rpc: the type of the call.'."\n" - .'* msOfSpan: the duration exceeds a specific value.'."\n" - .'* clientIp: the IP address of the client.'."\n" - .'* serverIp: the IP address of the server.'."\n" - .'* isError: specifies whether the call is abnormal.'."\n" - .'* hasTprof: contains only thread profiling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http.status_code', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ExclusionFilters', + 'name' => 'Type', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The filter conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key that is used to filter the query results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http.status_code', - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter the query results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '404', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The type of the application. Set the value to **TRACE**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TRACE', 'title' => ''], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'TraceInfos' => [ - 'description' => 'The details of the returned traces.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperationName' => [ - 'description' => 'The name of the traced span.'."\n", - 'type' => 'string', - 'example' => 'get***', - ], - 'ServiceIp' => [ - 'description' => 'The IP address of the host where the application resides.'."\n", - 'type' => 'string', - 'example' => '172.20.**.**', - ], - 'Duration' => [ - 'description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6', - ], - 'Timestamp' => [ - 'description' => 'The timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1595174436993', - ], - 'ServiceName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'arms-k8s-demo-subcomponent', - ], - 'TraceID' => [ - 'description' => 'The trace ID.'."\n", - 'type' => 'string', - 'example' => 'ac1400a115951744369937024d****', - ], - 'SpanID' => [ - 'description' => 'Span ID. You can get it from the **Trace Explorer** page of the ARMS console.', - 'type' => 'string', - 'example' => 'be3d6dcf5750e***', - ], - ], - 'description' => '', - ], - ], + 'Data' => ['description' => 'The result of turning on or off the main switch of the agent or the main switch status of the agent. Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* success'."\n" + .'* failed'."\n" + ."\n" + .'The main switch status of the agent. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'string', 'example' => 'abc@def success\\nghi@jkl success\\n', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空', 'description' => ''], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"TraceInfos\\": [\\n {\\n \\"OperationName\\": \\"get***\\",\\n \\"ServiceIp\\": \\"172.20.**.**\\",\\n \\"Duration\\": 6,\\n \\"Timestamp\\": 1595174436993,\\n \\"ServiceName\\": \\"arms-k8s-demo-subcomponent\\",\\n \\"TraceID\\": \\"ac1400a115951744369937024d****\\",\\n \\"SpanID\\": \\"be3d6dcf5750e***\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchTracesResponse>\\n <RequestId>4C518054-852F-4023-ABC1-4AF95FF7****</RequestId>\\n <TraceInfos>\\n <OperationName>get***</OperationName>\\n <ServiceIp>172.20.**.**</ServiceIp>\\n <Duration>6</Duration>\\n <Timestamp>1595174436993</Timestamp>\\n <ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n <TraceID>ac1400a115951744369937024d****</TraceID>\\n </TraceInfos>\\n</SearchTracesResponse>","errorExample":""}]', - 'title' => 'SearchTraces', - 'summary' => 'Queries traces by time, application name, IP address, span name, and tag.', - 'description' => '> A maximum of 100 data entries can be returned each time this operation is called. If you want to query all existing traces, we recommend that you call the SearchTracesByPage operation. For more information, see [SearchTracesByPage](~~175866~~).'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"abc@def success\\\\\\\\nghi@jkl success\\\\\\\\n\\",\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<ConfigAppResponse>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n <Data>abc@def success\\\\nghi@jkl success\\\\n</Data>\\n</ConfigAppResponse>","errorExample":""}]', + 'title' => 'ConfigApp', + 'description' => '****', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'SearchTracesByPage' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-09-13T10:44:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-22T06:57:14.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateAlertContact' => [ + 'summary' => 'Creates an alert contact.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1595174400000', - ], - ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1595210400000', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ServiceName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'arms-k8s-demo-subcomponent', - ], - ], - [ - 'name' => 'OperationName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the traced span.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '/demo/queryNotExistDB/11', - ], - ], - [ - 'name' => 'MinDuration', + 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'JohnDoe', 'title' => ''], ], [ - 'name' => 'Reverse', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" - ."\n" - .'* `true`: sorts the query results in reverse chronological order.'."\n" - .'* `false`: sorts the query results in chronological order.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'ServiceIp', + 'name' => 'PhoneNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address of the host where the application resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '172.20.XX.XX', - ], + 'schema' => ['description' => 'The mobile number of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1381111****', 'title' => ''], ], [ - 'name' => 'PageNumber', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The email address of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'someone@example.com', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'DingRobotWebhookUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Maximum value: 100.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '5', - ], + 'schema' => ['description' => 'The webhook URL of the DingTalk chatbot. For more information about how to obtain the URL, see [Configure a DingTalk chatbot to send alert notifications](https://www.alibabacloud.com/help/zh/doc-detail/106247.htm). You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" + ."\n" + .'> Enter `alert` in the custom keyword field of DingTalk chatbot security settings.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'SystemNoc', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b590lhguqs@9781be0f44dXXXX', - ], + 'schema' => ['description' => 'Specifies whether the alert contact receives system notifications. Valid values:'."\n" + ."\n" + .'* `true`: The alert contact receives system notifications.'."\n" + .'* `false`: The alert contact does not receive system notifications.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'ExclusionFilters', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The filter conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key that is used to filter the query results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http.status_code', - ], - 'Value' => [ - 'description' => 'The value of the key that is used to filter the query results.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '404', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, - ], + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag. The following system preset fields are provided:'."\n" - ."\n" - .'* traceId: the ID of the trace.'."\n" - .'* serverApp: the name of the server application.'."\n" - .'* clientApp: the name of the client application.'."\n" - .'* service: the name of the interface.'."\n" - .'* rpc: the type of the call.'."\n" - .'* msOfSpan: the duration exceeds a specific value.'."\n" - .'* clientIp: the IP address of the client.'."\n" - .'* serverIp: the IP address of the server.'."\n" - .'* isError: specifies whether the call is abnormal.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http.status_code', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 5, - ], - ], - [ - 'name' => 'IsError', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to include the traces of abnormal calls.'."\n" - ."\n" - .'* `true`: No'."\n" - .'* `false` (default): Yes'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aek2eq4peca****', 'title' => ''], ], ], 'responses' => [ @@ -4972,262 +1871,103 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'PageBean' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - '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' => '5', - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1601', - ], - 'TraceInfos' => [ - 'description' => 'The details of the returned traces.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'OperationName' => [ - 'description' => 'The name of the traced span.'."\n", - 'type' => 'string', - 'example' => '/demo/queryException/12', - ], - 'ServiceIp' => [ - 'description' => 'The IP address of the host where the application resides.'."\n", - 'type' => 'string', - 'example' => '172.20.XX.XX', - ], - 'Duration' => [ - 'description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '679', - ], - 'Timestamp' => [ - 'description' => 'The timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1595174436994', - ], - 'ServiceName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'arms-k8s-demo-subcomponent', - ], - 'TraceID' => [ - 'description' => 'The trace ID.'."\n", - 'type' => 'string', - 'example' => 'ac1400a115951744369947025d****', - ], - 'SpanID' => [ - 'description' => 'The span ID of the trace.'."\n", - 'type' => 'string', - 'example' => 'be3d6dcf5750e***', - ], - ], - 'description' => '', - ], - ], - ], - ], + 'ContactId' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'string', 'example' => '102**', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'eventInfo' => [ - 'enable' => false, - 'eventNames' => [], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"Total\\": 1601,\\n \\"TraceInfos\\": [\\n {\\n \\"OperationName\\": \\"/demo/queryException/12\\",\\n \\"ServiceIp\\": \\"172.20.XX.XX\\",\\n \\"Duration\\": 679,\\n \\"Timestamp\\": 1595174436994,\\n \\"ServiceName\\": \\"arms-k8s-demo-subcomponent\\",\\n \\"TraceID\\": \\"ac1400a115951744369947025d****\\",\\n \\"SpanID\\": \\"be3d6dcf5750e***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchTracesByPageResponse>\\n <RequestId>4C518054-852F-4023-ABC1-4AF95FF7****</RequestId>\\n <PageBean>\\n <PageNumber>1</PageNumber>\\n <PageSize>5</PageSize>\\n <Total>1601</Total>\\n <TraceInfos>\\n <OperationName>/demo/queryException/12</OperationName>\\n <ServiceIp>172.20.XX.XX</ServiceIp>\\n <Duration>679</Duration>\\n <Timestamp>1595174436994</Timestamp>\\n <ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n <TraceID>ac1400a115951744369947025d****</TraceID>\\n </TraceInfos>\\n </PageBean>\\n</SearchTracesByPageResponse>","errorExample":""}]', - 'title' => 'SearchTracesByPage', - 'summary' => 'Queries traces by page. You can query traces by time range, application name, IP address, span name, or tag.', - 'requestParamsDescription' => ' ', + 'title' => 'CreateAlertContact', + 'description' => 'This operation is no longer maintained. To create or modify an alert contact, call the CreateOrUpdateContact operation provided by the new version of the Alert Management module.'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'GetAgentDownloadUrlV2' => [ - 'summary' => 'Obtains the URL for downloading an agent.', - 'methods' => [ - 'get', - 'post', + 'changeSet' => [ + ['createdAt' => '2022-12-23T04:12:34.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateAlertContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ContactId\\": \\"102**\\",\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlertContactResponse>\\n\\t<RequestId>E9C9DA3D-10FE-472E-9EEF-2D0A3E41****</RequestId>\\n\\t<ContactId>102**</ContactId>\\n</CreateAlertContactResponse>","errorExample":""}]', + ], + 'CreateAlertContactGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, + 'operationType' => 'readAndWrite', 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'abilityTreeCode' => '44428', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'AgentType', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The agent type.\\'."\n" - .'**Valid values:**'."\n" - ."\n" - .'* **JavaAgent**'."\n" - .'* **Instgo**'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'JavaAgent', - ], + 'schema' => ['description' => 'The name of the alert contact group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestGroup', 'title' => ''], ], [ - 'name' => 'OsType', + 'name' => 'ContactIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The operating system of the environment where the agent is installed.\\'."\n" - .'This parameter is required and valid only when **AgentType** is set to **Instgo**.\\'."\n" - .'**Valid values:**'."\n" - ."\n" - .'* **linux**'."\n" - .'* **darwin**'."\n" - .'* **windows**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'linux', - ], + 'schema' => ['description' => 'The IDs of contacts in the contact group. Separate multiple contact IDs with spaces. You can call the SearchAlertContact operation to query the contact IDs. For more information, see [SearchAlertContact](~~130703~~).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '12* 23* 34*', 'title' => ''], ], [ - 'name' => 'ArchType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The architecture type of the environment where the agent is installed.\\'."\n" - .'This parameter is required and valid only when **AgentType** is set to **Instgo**.\\'."\n" - .'**Valid values:**'."\n" - ."\n" - .'* **amd64**'."\n" - .'* **arm64**'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'amd64', - ], + 'schema' => ['description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Data' => [ - 'description' => 'The version number and download URL of the agent.'."\n", - 'type' => 'object', - 'properties' => [ - 'Version' => [ - 'description' => 'The version number of the agent.'."\n", - 'type' => 'string', - 'example' => '3.2.9', - ], - 'Url' => [ - 'description' => 'The download URL of the agent.'."\n", - 'type' => 'string', - 'example' => 'http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip', - ], - ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Code' => [ - 'description' => 'The HTTP status code.\\'."\n" - .'**Valid values:**'."\n" - ."\n" - .'* 2xx: The request was successful.'."\n" - .'* 3xx: The request was redirected.'."\n" - .'* 4xx: The request was invalid.'."\n" - .'* 5xx: A server error occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.\\'."\n" - .'**Valid values:**'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'ContactGroupId' => ['description' => 'The ID of the alert contact group.'."\n", 'type' => 'string', 'example' => '446*', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '70675725-8F11-4817-8106-CFE0AD71****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - 404 => [ - [ - 'errorCode' => 'AppNotExist', - 'errorMessage' => 'The application does not exist.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ContactGroupId\\": \\"446*\\",\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlertContactGroupResponse>\\n\\t<ContactGroupId>446*</ContactGroupId>\\n\\t<RequestId>70675725-8F11-4817-8106-CFE0AD71****</RequestId>\\n</CreateAlertContactGroupResponse>","errorExample":""}]', + 'title' => 'CreateAlertContactGroup', + 'summary' => 'Creates an alert contact group.', + 'description' => 'The current API operation is no longer maintained. Call the CreateOrUpdateContactGroup operation of the new Alert Management module to create or modify alert contact groups.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-14T01:30:44.000Z', 'description' => 'Error codes changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Data\\": {\\n \\"Version\\": \\"3.2.9\\",\\n \\"Url\\": \\"http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip\\"\\n },\\n \\"Message\\": \\"探针类型错误\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetAgentDownloadUrlV2', ], - 'GetAgentDownloadUrl' => [ - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateDispatchRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5237,18 +1977,19 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '44431', + 'abilityTreeNodes' => ['FEATUREarmsVBCGEE'], ], 'parameters' => [ [ + 'name' => 'DispatchRule', + 'in' => 'query', + 'schema' => ['description' => 'The dispatch rule configuration. The value is a JSON string. For more information about this parameter, see the following **additional information about the DispatchRule parameter**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "system": false, "ruleid": 10282, "name": "Prometheus Alert", "labelMatchExpressionGrid": { "labelMatchExpressionGroups": [ { "labelMatchExpressions": [ { "key": "_aliyun_arms_involvedObject_kind", "value": "app", "operator": "eq" } ] } ] }, "dispatchType": "CREATE_ALERT/DISCARD_ALERT", "isRecover": true, "groupRules": [ { "groupId": 1, "groupingFields": [ "alertname" ], "groupWait": 10, "groupInterval": 15, "repeatInterval": 20 } ], "notifyRules": [ { "notifyObjects": [ { "notifyType": "ARMS_CONTACT", "name": "JohnDoe", "notifyObjectId": 1 }, { "notifyType": "ARMS_CONTACT_GROUP", "name": "JohnDoe_group", "notifyObjectId": 2 } ], "notifyChannels":["dingTalk","wechat","webhook","email"] }, ], }', 'title' => ''], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -5256,375 +1997,319 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'ArmsAgentDownloadUrl' => [ - 'description' => 'The download URL of the ARMS agent.'."\n", - 'type' => 'string', - 'example' => 'http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '14043452-D486-4EA1-80C9-BA73FB81****', - ], + 'DispatchRuleId' => ['description' => 'The ID of the dispatch policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10413', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ArmsAgentDownloadUrl\\": \\"http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/\\",\\n \\"RequestId\\": \\"14043452-D486-4EA1-80C9-BA73FB81****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAgentDownloadUrlResponse>\\n<ArmsAgentDownloadUrl>http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/</ArmsAgentDownloadUrl>\\n<RequestId>14043452-D486-4EA1-80C9-BA73FB81****</RequestId>\\n</GetAgentDownloadUrlResponse>","errorExample":""}]', - 'title' => 'GetAgentDownloadUrl', - 'summary' => 'Obtains the URL for downloading an agent.', - 'requestParamsDescription' => ' ', + 'title' => 'CreateDispatchRule', + 'summary' => 'Creates a dispatch policy.', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateNotificationPolicy接口创建或修改通知策略。', + 'requestParamsDescription' => '## Additional information about the **DispatchRule** parameter'."\n" + ."\n" + .'**JSON string example and description**'."\n" + ."\n" + .'```'."\n" + ."\n" + .'{'."\n" + .' "system": false, // Specifies whether the dispatch rule is editable. Valid values: true: not editable. false: editable. '."\n" + .' "ruleid": 10282, // The ID of the dispatch rule. '."\n" + .' "name": "Prometheus Alert", // The name of the dispatch policy. '."\n" + .' "labelMatchExpressionGrid": {'."\n" + .' "labelMatchExpressionGroups": [ // Sets the dispatch rule. '."\n" + .' {'."\n" + .' "labelMatchExpressions": ['."\n" + .' {'."\n" + .' "key": "_aliyun_arms_involvedObject_kind", // The key of the tag of the dispatch rule. For more information, see the next section. '."\n" + .' "value": "app", // The value of the tag. '."\n" + .' "operator": "eq" // The operator used in the dispatch rule. Valid values: eq: equals to. re: matches a regular expression. '."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dispatchType": "CREATE_ALERT/DISCARD_ALERT", // The alert handling method. Valid values: CREATE_ALERT: generates an alert. DISCARD_ALERT: discards the alert event and generates no alert. '."\n" + .' "isRecover": true, // Specifies whether to send the restored alert. Valid values: true: sends the alert. false: does not send the alert. '."\n" + .' "groupRules": [ // Sets the event group. '."\n" + .' {'."\n" + .' "groupId": 1, // The ID of the group. '."\n" + .' "groupingFields": [ // The fields that are used to group events. Events with the same field content are assigned to a group. Alerts with the same specified grouping field are sent to the handler in separate notifications. '."\n" + .' "alertname"'."\n" + .' ],'."\n" + .' "groupWait": 10, // The duration for which the system waits after the first alert is sent. After the duration, all alerts are sent in a single notification to the handler. '."\n" + .' "groupInterval": 15, // The grouping interval. During the silence period of repeated alerts, if new alerts are generated, they will be sent after the group waiting time. '."\n" + .' "repeatInterval": 20 // The silence period of repeated alerts. All alerts are repeatedly sent at specified intervals until the alerts are cleared. '."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyRules": [ // Sets the notification rule. '."\n" + .' {'."\n" + .' "notifyObjects": ['."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT", // The type of the alert contact. Valid values: ARMS_CONTACT: contact. ARMS_CONTACT_GROUP: contact group. '."\n" + .' "name": "JohnDoe", // The name of the contact or contact group. '."\n" + .' "notifyObjectId": 1 // The ID of the contact or contact group. '."\n" + .' },'."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT_GROUP",'."\n" + .' "name": "JohnDoe_group",'."\n" + .' "notifyObjectId": 2'."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyChannels":["dingTalk","wechat","webhook","email"] // The notification method. Valid values: dingTalk, sms, webhook, email, and wechat. '."\n" + .' },'."\n" + .' ],'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'**Enumerated keys of the tag of the dispatch rule**'."\n" + ."\n" + .'* `_aliyun_arms_userid`: user ID'."\n" + .'* `_aliyun_arms_involvedObject_kind`: type of the associated object'."\n" + .'* `_aliyun_arms_involvedObject_id`: ID of the associated object'."\n" + .'* `_aliyun_arms_involvedObject_name`: name of the associated object'."\n" + .'* `_aliyun_arms_alert_name`: alert name'."\n" + .'* `_aliyun_arms_alert_rule_id`: alert rule ID'."\n" + .'* `_aliyun_arms_alert_type`: alert type'."\n" + .'* `_aliyun_arms_alert_level`: alert severity'."\n", 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribeTraceLicenseKey' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2024-06-21T08:17:49.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'LicenseKey' => [ - 'description' => 'The license key for the application.'."\n", - 'type' => 'string', - 'example' => 'b590lhguqs@3a75d95f218****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '29053944-6FE5-4240-8927-10095ECE****', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"LicenseKey\\": \\"b590lhguqs@3a75d95f218****\\",\\n \\"RequestId\\": \\"29053944-6FE5-4240-8927-10095ECE****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTraceLicenseKeyResponse>\\n <LicenseKey>b590lhguqs@3a75d95f218****</LicenseKey>\\n <RequestId>29053944-6FE5-4240-8927-10095ECE****</RequestId>\\n</DescribeTraceLicenseKeyResponse>","errorExample":""}]', - 'title' => 'DescribeTraceLicenseKey', - 'summary' => 'Queries the license key.', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"DispatchRuleId\\": 10413,\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDispatchRuleResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <DispatchRuleId>10413</DispatchRuleId>\\n</CreateDispatchRuleResponse>","errorExample":""}]', ], - 'ListInsightsEvents' => [ - 'summary' => 'Queries the abnormal Insights events within a specified period of time.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateEnvCustomJob' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'AliyunLang', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the application.'."\n", + 'title' => '', + 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'aokcdqn3ly@a195c6d6421****', + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], + 'example' => 'zh', ], ], [ - 'name' => 'StartTime', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. The value is a timestamp.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1595174400000', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'env-xxxxxx'], ], [ - 'name' => 'EndTime', + 'name' => 'CustomJobName', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The value is a timestamp.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1480607940000', - ], + 'schema' => ['title' => '', 'description' => 'The name of the custom job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob1'], ], [ - 'name' => 'InsightsTypes', - 'in' => 'query', - 'schema' => [ - 'description' => 'The types of the events that you want to query. Separate multiple event types with commas (,). If you do not specify this parameter, all events are queried.'."\n" - ."\n" - .'* errorIncrease: API error-rate spike events. Examples: HTTP API error-rate spike events and Dubbo API error-rate spike events.'."\n" - .'* topErrorIncrease: the top five API error-rate spike events with the highest traffic.'."\n" - .'* topRtIncrease: API response-time spike events. Examples: HTTP API response-time spike events and Dubbo API response-time spike events.'."\n" - .'* rtIncrease: the top five API response-time spike events with the highest traffic.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'errorIncrease,topErrorIncrease,topExceptionIncrease,topRtIncrease,rtIncrease', - ], + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The YAML configuration string of the custom job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '参见补充说明。'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6F1174DC-6085-5353-AAE7-D4ADCD******', - ], - 'InsightsEvents' => [ - 'description' => 'The details of the event.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Title' => [ - 'description' => 'The title of the event.'."\n", - 'type' => 'string', - 'example' => 'Average response-time spikes of application services'."\n", - ], - 'Desc' => [ - 'description' => 'The description of the alert event.'."\n", - 'type' => 'string', - 'example' => 'The overall response time of the \\[HTTP] service of the application \\[sd] spikes at \\[2022-07-27 10:57:00]'."\n", - ], - 'Type' => [ - 'description' => 'The type of the event.'."\n", - 'type' => 'string', - 'example' => 'rtIncrease', - ], - 'Pid' => [ - 'description' => 'The ID of the application associated with the event.'."\n", - 'type' => 'string', - 'example' => 'dsv9zcel92@7da413b******', - ], - 'Level' => [ - 'description' => 'The severity of the event.'."\n", - 'type' => 'string', - 'example' => 'P3', - ], - 'Date' => [ - 'description' => 'The time when the event occurred. The value is a timestamp.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1658890560', - ], - 'ProblemId' => [ - 'description' => 'The problem identifier.'."\n", - 'type' => 'string', - 'example' => 'erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******', - ], - ], - 'description' => '', - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The name of the custom job that was created, or the exception information.'."\n", 'type' => 'string', 'example' => 'cutomJob1'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F1174DC-6085-5353-AAE7-D4ADCD******\\",\\n \\"InsightsEvents\\": [\\n {\\n \\"Title\\": \\"应用服务整体平均响应时间突增\\",\\n \\"Desc\\": \\"应用【sd】【HTTP】服务整体的响应时间在【2022-07-27 10:57:00】出现突增\\",\\n \\"Type\\": \\"rtIncrease\\",\\n \\"Pid\\": \\"dsv9zcel92@7da413b******\\",\\n \\"Level\\": \\"P3\\",\\n \\"Date\\": 1658890560,\\n \\"ProblemId\\": \\"erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListInsightsEvents', - ], - 'QueryAppMetadata' => [ - 'summary' => 'Queries the encoding mapping content based on the metadata IDs and metadata type.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateEnvCustomJob', + 'summary' => 'Creates a custom job for an environment.', + 'extraInfo' => 'ConfigYaml示例：'."\n" + .'```'."\n" + .'scrape_configs:'."\n" + .'- job_name: job-demo1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .'- job_name: job-demo2'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .' http_sd_configs:'."\n" + .' - url: 127.0.0.1:9090'."\n" + .' refresh_interval: 30s'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvCustomJob'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"cutomJob1\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'CreateEnvPodMonitor' => [ + 'summary' => 'Creates a PodMonitor for an environment.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'MetaIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata IDs. Separate multiple IDs with commas (,).'."\n" - ."\n" - .'You can obtain the exception ID on the **Exception Analysis** page of your application in the ARMS console.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '4c9dd447,3c76c565', - ], - ], - [ - 'name' => 'MetaType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The metadata type. Valid values:'."\n" - ."\n" - .'* sql: obtains an SQL statement based on sqlId.'."\n" - .'* exception: obtains the exception stack based on exceptionId.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'exception' => 'exception', - 'sql' => 'sql', - ], - 'example' => 'sql', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'AliyunLang', 'in' => 'query', 'schema' => [ - 'description' => 'The process identifier (PID) of the application. You can obtain the PID of an application by calling the **ListTraceApps** operation.'."\n", + 'description' => 'The language. Valid values: zh and en. Default value: zh.', + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], 'type' => 'string', - 'required' => true, - 'example' => 'ggxw4lnjuz@54364d85b97dc56', + 'title' => '', + 'required' => false, + 'example' => 'zh', ], ], [ - 'name' => 'RegionId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the environment instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'env-xxxxxx'], ], [ - 'name' => 'StartTimeMs', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to perform only a dry run, without performing the actual request.', 'type' => 'boolean', 'docRequired' => false, 'title' => '', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'EndTimeMs', - 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int64', - ], + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['description' => 'The YAML configuration snippet for PodMonitor.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '参见补充说明。'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '51877BAC-330C-5845-BDFD-C7859AD33FB7', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The returned result, which indicates whether the operation was successful.', 'type' => 'object', - 'example' => '{\'408d5533\': \'SELECT * FROM user_base_info\'}', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* 2XX: The request is successful.'."\n" - .'* 3XX: A redirection message is returned.'."\n" - .'* 4XX: The request is invalid.'."\n" - .'* 5XX: A server error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - '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', + 'properties' => [ + 'MatchedMsg' => ['description' => 'Indicates whether targets are matched.', 'type' => 'string', 'title' => '', 'example' => '匹配成功。'], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'PodMonitorName' => ['description' => 'The name of the created PodMonitor.', 'type' => 'string', 'title' => '', 'example' => 'arms-admin-pm1'], + 'MatchedTargetCount' => ['description' => 'The number of matched targets.', 'type' => 'string', 'title' => '', 'example' => '1'], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateEnvPodMonitor', + 'extraInfo' => 'ConfigYaml Example: '."\n" + .'```'."\n" + .'apiVersion: monitoring.coreos.com/v1'."\n" + .'kind: PodMonitor'."\n" + .'metadata:'."\n" + .' name: arms-admin-pm1'."\n" + .' namespace: arms-prom'."\n" + .' annotations:'."\n" + .' arms.prometheus.io/discovery: \'true\''."\n" + .'spec:'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + .' release: arms-prometheus'."\n" + .' namespaceSelector:'."\n" + .' any: true '."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: 30s'."\n" + .' targetPort: 9335'."\n" + .' path: /metrics'."\n" + .' - interval: 10s'."\n" + .' targetPort: 9335'."\n" + .' path: /metrics1'."\n" + .'```'."\n" + .'where arms.prometheus.io /discovery must exist, and its value is "true", which means serviceMonitor is enabled, otherwise it means it is stopped.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvPodMonitor'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51877BAC-330C-5845-BDFD-C7859AD33FB7\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'QueryAppMetadata', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodMonitorName\\": \\"arms-admin-pm1\\",\\n \\"MatchedTargetCount\\": \\"1\\"\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'DeleteAppList' => [ - 'summary' => 'Deletes multiple applications at a time based on the process IDs (PIDs).', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'CreateEnvServiceMonitor' => [ + 'summary' => 'Creates a ServiceMonitor for an environment.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5632,38 +2317,43 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'title' => '', + 'description' => 'The language. Valid values:'."\n" + ."\n" + .'* zh (default): Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], + 'example' => 'zh', ], ], [ - 'name' => 'Pids', + 'name' => 'EnvironmentId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of PIDs for the applications monitored by Application Monitoring.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The PID of an application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["atc889zkcf@d8deedfa9bfxxxx", "acd129bfcf@d5daebfa6cdxxxx"]', - ], - 'required' => true, - 'docRequired' => true, - 'maxItems' => 800, - ], + 'schema' => ['title' => '', 'description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'env-xxxxxx'], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. The system checks whether the format is valid and whether targets are matched.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The YAML configuration file of the ServiceMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '参见补充说明。'], ], ], 'responses' => [ @@ -5673,80 +2363,64 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4B446DF2-3DDD-4B5B-8E3F-D5225120****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => '"{\\"code\\":200,\\"data\\":\\"{\\\\\\"code\\\\\\":200,\\\\\\"data\\\\\\":true,\\\\\\"errorCode\\\\ \\":\\\\\\"Deletion of application successful\\\\\\",\\\\\\"Message\\\\\\":\\\\\\"Deletion of application successful\\\\\\",\\\\\\"Successful\\\\\\":true,\\ \\\\"traceId\\\\\\":\\\\\\"0bc1667516940677164677396d0088\\\\\\"}\\",\\"errorCode\\":\\"Batch deletion of applications successful\\",\\"message\\":\\"Batch deletion of applications successful\\ ",\\"Success\\":true,\\"traceId\\":\\"210f470416940677161213505e0e7a\\"}"', - ], - 'Message' => [ - 'description' => 'The error message returned for invalid request parameters.'."\n", - 'type' => 'string', - 'example' => '"Deletion of application successful"', - ], - 'Success' => [ - 'description' => 'Indicates whether the specified applications are deleted. Valid values:'."\n" - ."\n" - .'* `true`: The applications are deleted.'."\n" - .'* `false`: The applications failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'MatchedMsg' => ['title' => '', 'description' => 'Indicates whether targets are matched.'."\n", 'type' => 'string', 'example' => '匹配成功。'], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'ServiceMonitorName' => ['title' => '', 'description' => 'The name of the created ServiceMonitor.'."\n", 'type' => 'string', 'example' => 'arms-admin1'], + 'MatchedTargetCount' => ['description' => 'The number of matched targets.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterUserIdIsNull', - 'errorMessage' => 'User ID is null.', - ], - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'ParameterResourceIdIsNull', - 'errorMessage' => 'Resource ID is null.', - ], - ], - 403 => [ - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateEnvServiceMonitor', + 'requestParamsDescription' => 'Sample ConfigYAML:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: ServiceMonitor'."\n" + .' metadata:'."\n" + .' name: arms-admin1'."\n" + .' namespace: arms-prom'."\n" + .' annotations:'."\n" + .' arms.prometheus.io/discovery: \'true\''."\n" + .' spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' port: operator'."\n" + .' path: /metrics'."\n" + .' - interval: 10s'."\n" + .' port: operator1'."\n" + .' path: /metrics'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + ."\n" + .'You must specify arms.prometheus.io/discovery and set the value to true to enable the ServiceMonitor.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvServiceMonitor'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B446DF2-3DDD-4B5B-8E3F-D5225120****\\",\\n \\"Data\\": \\"\\\\\\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"0bc1667516940677164677396d0088\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"批量删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"批量删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"210f470416940677161213505e0e7a\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"Message\\": \\"“批量删除应用成功”\\",\\n \\"Success\\": true,\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'DeleteAppList', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"ServiceMonitorName\\": \\"arms-admin1\\",\\n \\"MatchedTargetCount\\": 1\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'DoInsightsAction' => [ - 'summary' => 'Performs actions based on the specified module type.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'https', - ], + 'CreateEnvironment' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -5754,536 +2428,374 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '227392', - 'abilityTreeNodes' => [ - 'FEATUREarmsXHEL9X', - ], - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Module', - 'in' => 'formData', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', 'schema' => [ - 'description' => 'The module type.'."\n" - ."\n" - .'* QueryTopo'."\n" - ."\n" - .' Queries topologies. A topology consists of edges and nodes, where each edge has a corresponding type and each node corresponds to an entity, which also has its type. By setting filter parameters such as the type of edges, the type of nodes, and the query time range, you can filter out the required topology data.'."\n" - ."\n" - .'* QueryTopoRed'."\n" - ."\n" - .' Queries topology RED metrics (number of requests, duration, number of errors). When querying a topology with the metric query option enabled, it might not be possible to retrieve all metric data due to the topology being too large. This module allows users to actively query for metric data of specified nodes and edges.'."\n" - ."\n" - .'Note: The aforementioned modules are currently in a canary release phase and are not enabled by default. If you need to enable them, please contact the ARMS on-duty number.'."\n" + 'description' => 'The language. Default value: zh.'."\n" ."\n" .'Valid values:'."\n" ."\n" - .'* QueryTopoRed'."\n" - .'* QueryTopo'."\n", + .'- en: English'."\n" + ."\n" + .'- zh: Chinese', + 'enumValueTitles' => ['en' => 'en', 'zh' => 'zh'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'QueryTopoRed' => '', - 'QueryTopo' => '', - ], - 'example' => 'QueryTopo', + 'title' => '', + 'required' => false, + 'example' => 'zh', ], ], [ - 'name' => 'Data', - 'in' => 'formData', + 'name' => 'EnvironmentName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The name of the environment.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'env1'], + ], + [ + 'name' => 'EnvironmentType', + 'in' => 'query', 'schema' => [ - 'description' => 'The query parameters. Different module types correspond to different query parameters.'."\n" - ."\n" - .'* QueryTopo'."\n" - ."\n" - .'<!---->'."\n" - ."\n" - .' {'."\n" - .' "regionId": string, # The region ID.'."\n" - .' "startTime": string, #. The start time. Format: yyyy-MM-dd HH:mm:ss.'."\n" - .' "endTime": string, # The end time. Format: yyyy-MM-dd HH:mm:ss.'."\n" - .' "edgeFilter": { # The edge filter condition.'."\n" - .' "includeTypes": [enum], # The edge types to be included.'."\n" - .' "excludeTypes": [enum], # The edge types to be excluded.'."\n" - .' "fromNodeFilter": { # The source node filter condition.'."\n" - .' "includeEntityTypes": [enum] # The entity types to be included.'."\n" - .' "excludeEntityTypes": [enum] #The entity types to be excluded.'."\n" - .' },'."\n" - .' "toNodeFilter": { #The target node filter condition.'."\n" - .' "includeEntityTypes": [enum] # The entity types to be included.'."\n" - .' "excludeEntityTypes": [enum] #The entity types to be excluded.'."\n" - .' }'."\n" - .' },'."\n" - .' "includeIsolatedNodes": boolean, #Specifies whether to include isolated nodes.'."\n" - .' "isolatedNodeFilter": { # The isolated node filter condition.'."\n" - .' "includeEntityTypes": [enum] # The entity types to be included.'."\n" - .' "excludeEntityTypes": [enum] #The entity types to be excluded.'."\n" - .' },'."\n" - .' "queryMetrics": boolean, # Specifies whether to query RED metrics along with metrics.'."\n" - .' "timeoutSecs": int, # The timeout period of metric query.'."\n" - .' "redOption": { # The metric query option.'."\n" - .' "skipRt": boolean, # Specifies whether to skip querying the response time.'."\n" - .' "skipCount": boolean, # Specifies whether to skip querying the number of requests.'."\n" - .' "skipError": boolean # Specifies whether to skip querying the number of errors.'."\n" - .' }'."\n" - .' }'."\n" + 'description' => 'The type of the environment. Valid values:'."\n" ."\n" - .'* QueryTopoRed'."\n" + .'- CS: Container Service'."\n" ."\n" - .'<!---->'."\n" + .'- ECS: Elastic Compute Service'."\n" ."\n" - .' {'."\n" - .' "regionId": string, # The region ID.'."\n" - .' "startTime": string, #. The start time. Format: yyyy-MM-dd HH:mm:ss.'."\n" - .' "endTime": string, # The end time. Format: yyyy-MM-dd HH:mm:ss.'."\n" - .' "edgeIds": [string] # The edge ID to be queried.'."\n" - .' "nodeIds": [string] # The node ID to be queried.'."\n" - .' "redOption": { # The metric query option.'."\n" - .' "skipRt": boolean, # Specifies whether to skip querying the response time.'."\n" - .' "skipRt": boolean, # Specifies whether to skip querying the number of requests.'."\n" - .' "skipError": boolean # Specifies whether to skip querying the number of errors.'."\n" - .' }'."\n" - .' }'."\n", + .'- Cloud: cloud service', 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => '- QueryTopo'."\n" - ."\n\n" - .' {'."\n" - .' "regionId": "cn-hangzhou",'."\n" - .' "startTime": "2024-07-23 19:16:00", '."\n" - .' "endTime": "2024-07-23 20:16:00", # Limit the topology query range to 2024-07-23 19:16:00 to 2024-07-23 20:16:00'."\n" - .' "edgeFilter": {'."\n" - .' "includeTypes": ['."\n" - .' "CALLS" # The resulting topology only contains edges of call relationships.'."\n" - .' ],'."\n" - .' "fromNodeFilter": {'."\n" - .' "includeEntityTypes": [ # The source node type of the call edge must be application type'."\n" - .' "APPLICATION" '."\n" - .' ]'."\n" - .' },'."\n" - .' "toNodeFilter": {'."\n" - .' "includeEntityTypes": [ # The target node of the call edge must be an application type or an external service type.'."\n" - .' "APPLICATION",'."\n" - .' "EXTERNAL_SERVICE"'."\n" - .' ]'."\n" - .' }'."\n" - .' },'."\n" - .' "includeIsolatedNodes": false, # The resulting topology does not contain isolated nodes'."\n" - .' "queryMetrics": true, # Synchronously query the RED indicator'."\n" - .' "timeoutSecs": 20, #It takes up to 20 seconds to query indicator data'."\n" - .' "redOption": { # The query indicators include time consumption, request volume, and query skip errors.'."\n" - .' "skipRt": false,'."\n" - .' "skipCount": false,'."\n" - .' "skipError": true'."\n" - .' }'."\n" - .' }'."\n" - ."\n\n" - ."\n" - .'- QueryTopoRed'."\n" - ."\n\n" - .' {'."\n" - .' "regionId": "cn-hangzhou",'."\n" - .' "startTime": "2024-07-23 10:00:00",'."\n" - .' "endTime": "2024-07-23 14:00:00",'."\n" - .' "edgeIds": ['."\n" - .' "097843bd50b06fbe2c6c1d8b761a7e8b"'."\n" - .' ],'."\n" - .' "nodeIds": ['."\n" - .' "23d973261c6923da1b5b7a571ec1aa8b"'."\n" - .' ],'."\n" - .' "redOption": { # The query indicators include time consumption, request volume, and query skip errors.'."\n" - .' "skipCount": false,'."\n" - .' "skipError": true,'."\n" - .' "skipRt": false'."\n" - .' }'."\n" - .' }'."\n", + 'enum' => ['CS', 'ECS', 'Cloud'], + 'title' => '', + 'example' => 'CS', ], ], [ - 'name' => 'RegionId', + 'name' => 'EnvironmentSubType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'title' => '', + 'description' => 'The subtype of the environment. Valid values:'."\n" + ."\n" + .'- CS: Container Service for Kubernetes (ACK) or Distributed Cloud Container Platform for Kubernetes (ACK One)'."\n" + ."\n" + .'- ECS: ECS'."\n" + ."\n" + .'- Cloud: cloud service', + 'enumValueTitles' => ['ECS' => 'ECS', 'Cloud' => 'Cloud', 'One' => 'One', 'ACK' => 'ACK'], 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797A64E', - ], - 'Code' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The response parameters vary with the value of module.'."\n" - ."\n" - .'* QueryTopo'."\n" - ."\n" - .' {'."\n" - .' "nodes": [Object] # The nodes. For more information, see node details in the supplementary notes of response parameters.'."\n" - .' "edges": [Object] # The edges. For more information, see edge details in the supplementary notes of response parameters.'."\n" - .' }'."\n" - ."\n" - .'* QueryTopoRed'."\n" - ."\n" - .' {'."\n" - .' "nodeRed": {'."\n" - .' "nodeId": {'."\n" - .' "count": double, # The total number of requests in the specified time range.'."\n" - .' "error": double, # The total number of errors in the specified time range.'."\n" - .' "rt": double, # The average response time in the specified time range. Unit: milliseconds.'."\n" - .' }'."\n" - .' },'."\n" - .' "edgeRed": {'."\n" - .' "edgeId": {'."\n" - .' "count": double, # The total number of requests in the specified time range.'."\n" - .' "error": double, # The total number of errors in the specified time range.'."\n" - .' "rt": double, # The average response time in the specified time range. Unit: milliseconds.'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'}'."\n" - ."\n" - .'```'."\n" - .'```'."\n", - 'type' => 'string', - 'example' => '- QueryTopo'."\n" - ."\n\n" - .' {'."\n" - .' "nodes": ['."\n" - .' {'."\n" - .' "nodeId": "3bfe1a747389273388182760406c079d",'."\n" - .' "entity": {'."\n" - .' "regionId": "cn-hangzhou",'."\n" - .' "appType": "TRACE",'."\n" - .' "appId": "xxxxxxxxxxxxxxxx",'."\n" - .' "name": "prometheus-pop-cn-hangzhou",'."\n" - .' "entityId": "3bfe1a747389273388182760406c079d",'."\n" - .' "firstSeenTms": 1721733226981,'."\n" - .' "lastSeenTms": 1721789171614,'."\n" - .' "type": "APPLICATION"'."\n" - .' },'."\n" - .' "attrs": {'."\n" - .' "RED": {'."\n" - .' "count": 643848.0,'."\n" - .' "error": 0.0,'."\n" - .' "rt": 172.31701892372112'."\n" - .' }'."\n" - .' }'."\n" - .' }'."\n" - .' ],'."\n" - .' "edges": ['."\n" - .' {'."\n" - .' "from": "98b4184b22e588cf86e9a29aa4179606",'."\n" - .' "to": "98b4184b22e588cf86e9a29aa4179606",'."\n" - .' "type": "CALLS",'."\n" - .' "attrs": {'."\n" - .' "RED": {'."\n" - .' "count": 4.0,'."\n" - .' "error": 0.0,'."\n" - .' "rt": 37.0'."\n" - .' }'."\n" - .' },'."\n" - .' "edgeId": "5d611597e4b0013d0947615c9eca4de6",'."\n" - .' "firstSeenTms": 1721783795125,'."\n" - .' "lastSeenTms": 1721787371614'."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - ."\n\n" - .'- QueryTopoRed'."\n" - ."\n" - .' {'."\n" - .' "nodeRed": {'."\n" - .' "361d9f32e58cef316bf2355f3ff05575": {'."\n" - .' "count": 3258110.0,'."\n" - .' "error": 74.0,'."\n" - .' "rt": 167.39844355494878'."\n" - .' }'."\n" - .' },'."\n" - .' "edgeRed": {}'."\n" - .' }'."\n" - ."\n", - ], - ], + 'required' => true, + 'docRequired' => true, + 'enum' => [], + 'example' => 'ECS、ACK等。', ], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797A64E\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"- QueryTopo\\\\n\\\\n\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"nodes\\\\\\": [\\\\n\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"nodeId\\\\\\": \\\\\\"3bfe1a747389273388182760406c079d\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"entity\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"appType\\\\\\": \\\\\\"TRACE\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"appId\\\\\\": \\\\\\"xxxxxxxxxxxxxxxx\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"prometheus-pop-cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"entityId\\\\\\": \\\\\\"3bfe1a747389273388182760406c079d\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"firstSeenTms\\\\\\": 1721733226981,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"lastSeenTms\\\\\\": 1721789171614,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"APPLICATION\\\\\\"\\\\n\\\\t\\\\t\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"attrs\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"RED\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"count\\\\\\": 643848.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"error\\\\\\": 0.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"rt\\\\\\": 172.31701892372112\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t],\\\\n\\\\t\\\\t\\\\\\"edges\\\\\\": [\\\\n\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"from\\\\\\": \\\\\\"98b4184b22e588cf86e9a29aa4179606\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"to\\\\\\": \\\\\\"98b4184b22e588cf86e9a29aa4179606\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"CALLS\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"attrs\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"RED\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"count\\\\\\": 4.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"error\\\\\\": 0.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"rt\\\\\\": 37.0\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"edgeId\\\\\\": \\\\\\"5d611597e4b0013d0947615c9eca4de6\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"firstSeenTms\\\\\\": 1721783795125,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"lastSeenTms\\\\\\": 1721787371614\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t]\\\\n\\\\t}\\\\n\\\\n\\\\n- QueryTopoRed\\\\n\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"nodeRed\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\\\"361d9f32e58cef316bf2355f3ff05575\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"count\\\\\\": 3258110.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"error\\\\\\": 74.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"rt\\\\\\": 167.39844355494878\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\\\"edgeRed\\\\\\": {}\\\\n\\\\t}\\\\n\\\\n\\"\\n}","type":"json"}]', - 'title' => 'DoInsightsAction', - 'requestParamsDescription' => 'A topology consists of edges and nodes, where each edge has a corresponding type and each node corresponds to an entity, which also has its type. By setting filter parameters such as the type of edges, the type of nodes, and the query time range, you can filter out the required topology data.'."\n" - ."\n" - .'* Isolated node'."\n" - ."\n" - .' An isolated node is not related with other nodes.'."\n" - ."\n" - .'The field type "enum" indicates that the field comes from an enumeration. For more information about enumeration, see supplementary notes.'."\n", - 'responseParamsDescription' => '* Node details'."\n" - ."\n" - .' {'."\n" - .' "nodeId": string, # The node ID.'."\n" - .' "entity": Object, # The entity information. The fields vary with the specified type. For more information, see the "Entity types" section of this topic. '."\n" - .' "attrs": { # The attributes.'."\n" - .' "RED": { # The red metrics.'."\n" - .' "count": double, # The total number of requests in the specified time range.'."\n" - .' "error": double, # The total number of errors in the specified time range.'."\n" - .' "rt": double, # The average response time in the specified time range. Unit: milliseconds.'."\n" - .' }'."\n" - .' }'."\n" - .' }'."\n" - ."\n" - .'* Edge details'."\n" - ."\n" - .' {'."\n" - .' "from": string, # The ID of the source node.'."\n" - .' "to": string, # The ID of the target node.'."\n" - .' "type": enum, # The edge type. For more information, see the supplementary notes.'."\n" - .' "attrs": { # The attributes.'."\n" - .' "RED": { # The red metrics.'."\n" - .' "count": double, # The total number of requests in the specified time range.'."\n" - .' "error": double, # The total number of errors in the specified time range.'."\n" - .' "rt": double, # The average response time in the specified time range. Unit: milliseconds.'."\n" - .' }'."\n" - .' },'."\n" - .' "edgeId": string, # The edge ID.'."\n" - .' "firstSeenTms": long, # The time when the edge was first identified. Unit: milliseconds. Format: a UNIX timestamp.'."\n" - .' "lastSeenTms": long, # The time when the edge was last identified. Unit: milliseconds. Format: a UNIX timestamp.'."\n" - .' }'."\n", - ], - 'Upload' => [ - 'summary' => 'Uploads a SourceMap file to ARMS Browser Monitoring.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'BindResourceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The ID of the resource bound to the environment, such as the container ID or VPC ID. For a Cloud environment, specify the region ID.', 'type' => 'string', 'required' => true, 'docRequired' => false, 'title' => '', 'example' => 'c6e9dec475dca4a50a188411d8cbxxx'], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ManagedType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The ID of the region to which the SourceMap file is uploaded.'."\n", + 'description' => 'Specifies whether agents or exporters are managed. Valid values:'."\n" + ."\n" + .'- none: No. By default, no managed agents or exporters are provided for ACK clusters.'."\n" + ."\n" + .'- agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters.'."\n" + ."\n" + .'- agent-exporter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.', 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'required' => false, + 'docRequired' => false, + 'enum' => ['none', 'agent', 'agent-exporter'], + 'title' => '', + 'example' => 'none', ], ], [ - 'name' => 'Pid', + 'name' => 'FeePackage', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The application ID.'."\n" + 'description' => 'The payable resource plan.'."\n" ."\n" - .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with @ to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.'."\n", + .'- If the EnvironmentType parameter is set to CS, set the value to CS\\_Basic or CS\\_Pro. Default value: CS\\_Basic.'."\n" + ."\n" + .'- Otherwise, leave the parameter empty.', 'type' => 'string', - 'required' => true, - 'example' => 'b590lhguqs@8cc3f6354******', + 'required' => false, + 'docRequired' => false, + 'enum' => ['CS_Basic', 'CS_Pro'], + 'title' => '', + 'example' => 'CS_Basic', ], ], [ - 'name' => 'FileName', + 'name' => 'PrometheusInstanceId', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The name of the SourceMap file.'."\n", + 'description' => 'The ID of the Prometheus instance. If no Prometheus instance is created, call the InitEnvironment operation.', 'type' => 'string', - 'required' => true, - 'example' => 'test.js.map', + 'required' => false, + 'docRequired' => false, + 'enum' => [], + 'title' => '', + 'example' => 'c6e9dec475dca4a50a188411d8cbxxx', ], ], [ - 'name' => 'Version', + 'name' => 'GrafanaWorkspaceId', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'We recommend that you do not specify this parameter.'."\n", + 'description' => 'The ID of the Grafana workspace associated with the environment. If this parameter is left empty, the default shared Grafana workspace is used.', 'type' => 'string', 'required' => false, - 'example' => 'null', + 'docRequired' => false, + 'enum' => [], + 'title' => '', + 'example' => 'grafana-rnglkcdrntlhk0****', ], ], [ - 'name' => 'File', - 'in' => 'formData', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The string of the SourceMap file.'."\n", + 'description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, - 'example' => 'test file content', + 'docRequired' => false, + 'enum' => [], + 'title' => '', + 'example' => 'rg-acfmxyexli2****', ], ], [ - 'name' => 'Edition', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The version of the SourceMap file.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The tags of the instance. You can specify this parameter to manage tags for the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '0.0.0', + 'maxItems' => 21, + 'example' => '', ], ], + [ + 'name' => 'InitEnvironment', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to initialize the environment.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'UploadResult' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Fid' => [ - 'description' => 'The ID of the SourceMap file.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'FileName' => [ - 'description' => 'The name of the SourceMap file.'."\n", - 'type' => 'string', - 'example' => 'test.js.map', - ], - 'UploadTime' => [ - 'description' => 'The time when the file was uploaded.'."\n", - 'type' => 'string', - 'example' => '1650272251', - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The ID of the created environment.', 'type' => 'string', 'title' => '', 'example' => 'env-xxxxx'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterRegionIdMissing', - 'errorMessage' => 'You must specify regionId.', - ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - ], - 403 => [ - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'CreateEnvironment', + 'summary' => 'Creates an environment instance.', + 'changeSet' => [ + ['createdAt' => '2024-06-17T03:46:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-28T03:15:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-08T08:03:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-19T06:40:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-23T01:59:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-09T11:49:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-03T07:43:44.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvironment'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"UploadResult\\": {\\n \\"Fid\\": \\"123\\",\\n \\"FileName\\": \\"test.js.map\\",\\n \\"UploadTime\\": \\"1650272251\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UploadResponse>\\n <RequestId>xxxx</RequestId>\\n <Fid>1.0</Fid>\\n <FileName>test.txt</FileName>\\n <Version>0.0.0</Version>\\n <UploadTime>xxx</UploadTime>\\n</UploadResponse>","errorExample":""}]', - 'title' => 'Upload', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"env-xxxxx\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'DeleteSourceMap' => [ - 'summary' => 'Deletes the SourceMap files uploaded in Browser Monitoring.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'CreateGrafanaWorkspace' => [ + 'summary' => 'Create a Managed Service for Grafana workspace instance. ', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '164616', + 'abilityTreeNodes' => ['FEATUREarmsRY7LT8'], + 'autoTest' => false, + 'notSupportAutoTestReason' => '涉及数据库任务，为了客户恢复需求，数据库资源不做释放，自动化调用资源浪费', ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'GrafanaWorkspaceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the Grafana workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'testgrafana', 'title' => ''], + ], + [ + 'name' => 'GrafanaWorkspaceEdition', 'in' => 'query', 'schema' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", + 'description' => 'The edition.'."\n" + ."\n" + .'**Valid values:**'."\n" + ."\n" + .'* standard: `Beta Edition or Standard Edition`'."\n" + .'* personal_edition: Developer Edition'."\n" + .'* experts_edition: Pro Edition'."\n" + .'* advanced_edition: Advanced Edition'."\n", 'type' => 'string', 'required' => true, - 'example' => 'atc889zkcf@d8deedfa9bf****', + 'enumValueTitles' => [], + 'example' => 'experts_edition', + 'title' => '', ], ], [ - 'name' => 'FidList', + 'name' => 'Description', + 'in' => 'query', + 'schema' => ['description' => 'The description of the workspace', 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'GrafanaVersion', + 'in' => 'query', + 'schema' => ['description' => 'Grafana version. ', 'type' => 'string', 'required' => true, 'example' => '10.0.x', 'title' => ''], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => ['description' => 'The password of the workspace. The password must be 8 to 30 characters in length. It must include at least three of the following characters types: uppercase letter, lowercase letter, digit, and special character. Special characters include () \' ~ ! @ # $ % ^ & \\* - \\_ + =.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Test123456!', 'title' => ''], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Whether auto-renewal is enabled. Valid values: '."\n" + .'- true: Auto-renewal is enabled. '."\n" + .'- false: Auto-renewal is disabled. '."\n" + ."\n" + .'Default Value: true. ', 'type' => 'string', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => ['description' => '包年包月的计费周期，取值： Month（默认值）：按月购买。 Year：按年购买。', 'type' => 'string', 'required' => false, 'example' => 'Month', 'title' => ''], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => ['description' => 'Subscription duration of the instance. Valid values: '."\n" + ."\n" + .'- If PricingCycle is **Month**, indicating monthly billing, the value range is **1** to **9**. '."\n" + .'- If PricingCycle is **Year**, indicating yearly billing, the value range is **1** to **3**. '."\n" + ."\n" + .'Default Value: 1. ', 'type' => 'string', 'required' => false, 'example' => '6', 'title' => ''], + ], + [ + 'name' => 'AccountNumber', + 'in' => 'query', + 'schema' => ['description' => 'Account quantity. '."\n" + ."\n" + .'**Value description:** '."\n" + .'- If GrafanaWorkspaceEdition is **standard**, this parameter is invalid. '."\n" + .'- If GrafanaWorkspaceEdition is **personal_edition**, this parameter is invalid. Default Value: 1. '."\n" + .'- If GrafanaWorkspaceEdition is **experts_edition**, valid values are 10, 30, or 50. Default Value: 10. '."\n" + .'- If GrafanaWorkspaceEdition is **advanced_edition**, this parameter is invalid. Default Value: 100. ', 'type' => 'string', 'required' => false, 'example' => '10', 'title' => ''], + ], + [ + 'name' => 'CustomAccountNumber', + 'in' => 'query', + 'schema' => ['description' => 'Additional custom account quantity for the User. '."\n" + ."\n" + .'**Value description:** '."\n" + .'- If GrafanaWorkspaceEdition is **standard**, this parameter is invalid. '."\n" + .'- If GrafanaWorkspaceEdition is **personal_edition**, this parameter is invalid. '."\n" + .'- If GrafanaWorkspaceEdition is **experts_edition**, this parameter is invalid. '."\n" + .'- If GrafanaWorkspaceEdition is **advanced_edition**, the value range is 0 to 2000 and must be a multiple of 10. Default Value: 0. ', 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Default value: zh. Valid values:'."\n" + ."\n" + .'* zh'."\n" + .'* en'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'default' => 'zh', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the SourceMap files.'."\n", + 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The IDs of the SourceMap files.'."\n", - 'type' => 'string', + 'description' => 'Tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], 'required' => false, - 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, + 'title' => '', + 'example' => '', ], ], ], @@ -6291,115 +2803,107 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Data' => [ - 'description' => 'Indicates whether the SourceMap files are deleted. Valid values:'."\n" - ."\n" - .'* success: The SourceMap files are deleted.'."\n" - .'* false: The SourceMap files fail to be deleted.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****'], + 'Data' => ['description' => 'The information about the Grafana workspace.'."\n", '$ref' => '#/components/schemas/GrafanaWorkspace', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TraceId' => ['description' => 'The ID of the trace.'."\n", 'type' => 'string', 'example' => 'eac0a8048716731735000007137d000b', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteSourceMap', - ], - 'GetSourceMapInfo' => [ - 'summary' => 'Obtains the details of the SourceMap file uploaded in Browser Monitoring.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ResourceIdIsIllegal', 'errorMessage' => 'The specified ResourceId is invalid.', 'description' => 'The parameter ResourceId is illegal.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['errorCode' => 'AccountUidAccessError', 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create Grafana Workspace ', + 'description' => 'Ensure that you fully understand the billing method and <props="china">[pricing](https://help.aliyun.com/zh/grafana/product-overview/billing-4?spm=openapi-amp.newDocPublishment.0.0.7453281fkrsWrp)</props><props="intl">[pricing](https://www.alibabacloud.com/help/zh/grafana/product-overview/billing-4?spm=a2c4g.11186623.0.0.14c2d253B3SDbt)</props> of the Managed Service for Grafana product before using this API. '."\n" + .'> '."\n" + .'> - Identity verification is required to create a Managed Service for Grafana instance. <props="china">You can refer to the [Account Identity Verification](https://help.aliyun.com/zh/account/user-guide/individual-identities) documentation to complete the verification.</props> '."\n" + .'> - Regular users can only create Developer, Expert, or Pro editions (`fees apply`). '."\n" + .'> - Internal testing users can only create the internal testing edition (`free of charge`). ', + 'changeSet' => [ + ['createdAt' => '2024-12-06T03:20:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-05T08:19:19.000Z', 'description' => 'Request parameters changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGrafanaWorkspace'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D80ADAAC-8C32-5479-BD14-C28CF832****\\",\\n \\"Data\\": {\\n \\"status\\": \\"Starting、Running、Stop、DeleteSucceed\\",\\n \\"description\\": \\"线上生产环境Grafana\\",\\n \\"grafanaWorkspaceEdition\\": \\"personal_edition、experts_edition、advanced_edition、standard\\",\\n \\"endTime\\": 1652803200000,\\n \\"grafanaWorkspaceId\\": \\"grafana-cn-4xl3g******\\",\\n \\"upgradeVersion\\": [\\n \\"9.0.x\\"\\n ],\\n \\"grafanaWorkspaceIp\\": \\"47.110.71.***:443\\",\\n \\"snatIp\\": \\"47.110.71.***\\",\\n \\"grafanaWorkspaceDomain\\": \\"my-grafana.grafana.aliyuncs.com:443\\",\\n \\"grafanaWorkspaceDomainStatus\\": \\"on\\",\\n \\"commercial\\": true,\\n \\"grafanaWorkspaceName\\": \\"线上生产环境Grafana\\",\\n \\"grafanaVersion\\": \\"9.0.x\\",\\n \\"gmtCreate\\": 1642079398000,\\n \\"userId\\": \\"1412143830******\\",\\n \\"maxAccount\\": \\"10\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"protocol\\": \\"http、https\\",\\n \\"shareSynced\\": true,\\n \\"ntmId\\": \\"grafana-cn-4xl3g******\\",\\n \\"personalDomain\\": \\"my-grafana.grafana.aliyuncs.com:443\\",\\n \\"personalDomainPrefix\\": \\"my-grafana\\",\\n \\"resourceGroupId\\": \\"rg-aek2f4vzrfs6cla\\",\\n \\"deployType\\": \\"asi\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"TestKey\\",\\n \\"value\\": \\"TestValue\\"\\n }\\n ],\\n \\"privateIp\\": \\"192.168.1.1\\\\n\\",\\n \\"privateDomain\\": \\"my-grafana.grafana.aliyuncs.com:80\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'CreateIntegration' => [ + 'summary' => 'Creates an alert integration.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ID', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the SourceMap file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', - ], + 'name' => 'IntegrationName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'required' => true, 'example' => '云监控集成'], ], [ - 'name' => 'Keyword', - 'in' => 'query', - 'schema' => [ - 'description' => 'The keyword in the file name. The files are searched by keyword.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], + 'name' => 'IntegrationProductType', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The service of the alert integration. Valid values:'."\n" + ."\n" + .'* CLOUD_MONITOR: CloudMonitor'."\n" + .'* LOG_SERVICE: Log Service'."\n", 'type' => 'string', 'required' => true, 'example' => 'CLOUD_MONITOR'], ], [ - 'name' => 'OrderField', - 'in' => 'query', - 'schema' => [ - 'description' => 'The criterion by which the files are sorted. Valid values:'."\n" - ."\n" - .'* version: The files are sorted by version.'."\n" - .'* uploadTime: The files are sorted by upload time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'version', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The description of the alert integration.'."\n", 'type' => 'string', 'required' => false, 'example' => '测试'], ], [ - 'name' => 'AscendingSequence', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which the files are sorted. Valid values:'."\n" - ."\n" - .'* true: ascending order'."\n" - .'* false: descending order'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'AutoRecover', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to automatically clear alert events. Default value: true. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'RecoverTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The period of time within which alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300'], ], [ - 'name' => 'Edition', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the SourceMap file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -6409,257 +2913,784 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'SourceMapList' => [ - 'description' => 'The details of the SourceMap file.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Fid' => [ - 'description' => 'The ID of the SourceMap file.'."\n", - 'type' => 'string', - 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', - ], - 'FileName' => [ - 'description' => 'The name of the SourceMap file.'."\n", - 'type' => 'string', - 'example' => 'test.sourcemap.js', - ], - 'Size' => [ - 'description' => 'The size of the file. Unit: KB.'."\n", - 'type' => 'string', - 'example' => '201223', - ], - 'UploadTime' => [ - 'description' => 'The timestamp that indicates when the file was uploaded.'."\n", - 'type' => 'string', - 'example' => '1590657842000', - ], - 'Version' => [ - 'description' => 'The version of the file.'."\n", - 'type' => 'string', - 'example' => '0.0.0', - ], - ], - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****'], + 'Integration' => [ + 'description' => 'The returned information about the alert integration.'."\n", + 'type' => 'object', + 'properties' => [ + 'IntegrationId' => ['title' => '', 'description' => 'The ID of the alert integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'IntegrationName' => ['title' => '', 'description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'example' => '云监控集成'], + 'IntegrationProductType' => ['title' => '', 'description' => 'The service of the alert integration. Valid values:'."\n" + ."\n" + .'* CLOUD_MONITOR: CloudMonitor'."\n" + .'* LOG_SERVICE: Log Service'."\n", 'type' => 'string', 'example' => 'CLOUD_MONITOR'], + 'Description' => ['title' => '', 'description' => 'The description of the alert integration.'."\n", 'type' => 'string', 'example' => '测试'], + 'AutoRecover' => ['title' => '', 'description' => 'Indicates whether alert events are automatically cleared. Default value: true. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RecoverTime' => ['title' => '', 'description' => 'The period of time within which alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300'], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"SourceMapList\\": [\\n {\\n \\"Fid\\": \\"atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js\\",\\n \\"FileName\\": \\"test.sourcemap.js\\",\\n \\"Size\\": \\"201223\\",\\n \\"UploadTime\\": \\"1590657842000\\",\\n \\"Version\\": \\"0.0.0\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetSourceMapInfo', - ], - 'CreateRetcodeApp' => [ - 'summary' => 'Creates a Browser Monitoring task for an application.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Integration\\": {\\n \\"IntegrationId\\": 1234,\\n \\"IntegrationName\\": \\"云监控集成\\",\\n \\"IntegrationProductType\\": \\"CLOUD_MONITOR\\",\\n \\"Description\\": \\"测试\\",\\n \\"AutoRecover\\": true,\\n \\"RecoverTime\\": 300\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateIntegration', + 'changeSet' => [ + ['createdAt' => '2024-01-30T10:49:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-24T02:52:43.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegration'], + ], ], + ], + 'CreateOrUpdateAlertRule' => [ + 'summary' => 'Create or modify alarm rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '104428', + 'abilityTreeNodes' => ['FEATUREarms20UGKV'], ], 'parameters' => [ [ - 'name' => 'RetcodeAppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'SdkTest', - ], + 'name' => 'AlertId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the alert rule.'."\n" + ."\n" + .'- Omit this parameter to create a new alert rule.'."\n" + ."\n" + .'- Specify an ID to modify an existing alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '546xxx', 'title' => '', 'required' => false], ], [ - 'name' => 'RetcodeAppType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* `web`: web application'."\n" - .'* `weex`: Weex mobile app'."\n" - .'* `mini_dd`: DingTalk mini program'."\n" - .'* `mini_alipay`: Alipay mini program'."\n" - .'* `mini_wx`: WeChat mini program'."\n" - .'* `mini_common`: mini program on other platforms'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'mini_dd', - ], + 'name' => 'AlertName', + 'in' => 'formData', + 'schema' => ['description' => 'The alert rule name.', 'type' => 'string', 'required' => true, 'example' => 'Alert Rule Demo', 'title' => ''], ], [ 'name' => 'RegionId', - 'in' => 'query', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'AlertType', + 'in' => 'formData', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'- `APPLICATION_MONITORING_ALERT_RULE`: For application monitoring.'."\n" + ."\n" + .'- `BROWSER_MONITORING_ALERT_RULE`: For browser monitoring.'."\n" + ."\n" + .'- `PROMETHEUS_MONITORING_ALERT_RULE`: For Prometheus monitoring.'."\n" + ."\n" + .'- `XTRACE_MONITORING_ALERT_RULE`: For Tracing Analysis (OpenTelemetry edition).'."\n" + ."\n" + .'- `EBPF_MONITORING_ALERT_RULE`: For eBPF monitoring.'."\n" + ."\n" + .'- `RUM_MONITORING_ALERT_RULE`: For real user monitoring (RUM).', + 'enumValueTitles' => [], 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'enum' => ['PROMETHEUS_MONITORING_ALERT_RULE', 'APPLICATION_MONITORING_ALERT_RULE', 'BROWSER_MONITORING_ALERT_RULE', 'prometheus monitoring alert', 'application monitoring alert', 'browser monitoring alert', 'XTRACE_MONITORING_ALERT_RULE', 'EBPF_MONITORING_ALERT_RULE', 'RUM_MONITORING_ALERT_RULE'], + 'title' => '', + 'example' => 'APPLICATION_MONITORING_ALERT_RULE', ], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'query', + 'name' => 'AlertStatus', + 'in' => 'formData', + 'schema' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- `RUNNING`: The alert rule is running. (Default)'."\n" + ."\n" + .'- `STOPPED`: The alert rule is stopped.', 'type' => 'string', 'required' => false, 'example' => 'RUNNING', 'title' => ''], + ], + [ + 'name' => 'NotifyStrategy', + 'in' => 'formData', + 'schema' => ['description' => 'The notification policy.'."\n" + ."\n" + .'- `null`: Does not associate the alert rule with a notification policy. You can associate them later by creating a notification policy with a matching rule, for example, based on the alert rule\'s name. When the alert rule is triggered, alert events are sent to the contacts or contact groups specified in the matching notification policy.'."\n" + ."\n" + .'- A notification policy ID: Associates the alert rule with a specific notification policy. ARMS automatically adds a matching rule to the policy that uses the alert rule\'s ID. This ensures that alert events from this rule are always processed by the specified policy.', 'type' => 'string', 'required' => false, 'example' => '569xxx', 'title' => ''], + ], + [ + 'name' => 'Pids', + 'in' => 'formData', + 'schema' => ['description' => 'The PIDs of applications for an application monitoring or browser monitoring alert rule. Specify as a JSON array of strings.', 'type' => 'string', 'required' => false, 'example' => '["b590lhguqs@40d8deedfa9******"]', 'title' => ''], + ], + [ + 'name' => 'AutoAddNewApplication', + 'in' => 'formData', + 'schema' => ['description' => 'Determines whether to automatically apply this alert rule to new applications. This applies only to application monitoring and browser monitoring rules.'."\n" + ."\n" + .'- `true`: enables the feature.'."\n" + ."\n" + .'- `false`: disables the feature.', 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'MetricsType', + 'in' => 'formData', + 'schema' => ['description' => 'The alert metric type for application monitoring or browser monitoring alert rules. For more information, see the table below.', 'type' => 'string', 'required' => false, 'example' => 'jvm', 'title' => ''], + ], + [ + 'name' => 'Filters', + 'in' => 'formData', + 'schema' => ['description' => 'The filters for an application monitoring or browser monitoring alert rule.'."\n" + .'Specify this parameter as a JSON string in the following format:'."\n" + ."\n" + .'```'."\n" + .'"DimFilters": [ '."\n" + .'{ '."\n" + .' "FilterOpt": "ALL",'."\n" + .' "FilterValues": [], // The filter value.'."\n" + .' "FilterKey": "rootIp" // The filter key.'."\n" + .'}'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'Valid values for **FilterOpt**:'."\n" + ."\n" + .'- `STATIC`: Matches a fixed dimension value.'."\n" + ."\n" + .'- `ALL`: Iterates over all dimension values. Note: This option is not supported for range detection.'."\n" + ."\n" + .'- `DISABLE`: Aggregates all dimension values by summing them.', 'type' => 'string', 'required' => false, 'example' => '{"DimFilters": [ { "FilterOpt": "ALL", "FilterValues": [], "FilterKey": "rootIp" } ] }', 'title' => ''], + ], + [ + 'name' => 'AlertRuleContent', + 'in' => 'formData', + 'schema' => ['description' => 'The content of the alert rule for application monitoring or browser monitoring. The following is a template for the **AlertRuleContent** parameter. For a description of the fields in the template, see the supplementary information below this table.'."\n" + ."\n" + .'```json'."\n" + .'{ '."\n" + .' "Condition": "OR",'."\n" + .' "AlertRuleItems": ['."\n" + .' { "Operator": "CURRENT_LTE",'."\n" + .' "MetricKey": "appstat.jvm.threadcount",'."\n" + .' "Value": 1000,'."\n" + .' "Aggregate": "AVG",'."\n" + .' "N": 10,'."\n" + .' "Tolerability": 169'."\n" + .' } '."\n" + .' ] '."\n" + .' }'."\n" + .'```'."\n" + ."\n" + .'> The available fields for **AlertRuleItems.MetricKey** depend on the **MetricsType** value. For information about the metric types supported by application monitoring and browser monitoring and their corresponding alert rule fields, see the supplementary information below this table.', 'type' => 'string', 'required' => false, 'example' => '{ '."\n" + .' "Condition": "OR",'."\n" + .' "AlertRuleItems": ['."\n" + .' { "Operator": "CURRENT_LTE",'."\n" + .' "MetricKey": "appstat.jvm.threadcount",'."\n" + .' "Value": 1000,'."\n" + .' "Aggregate": "AVG",'."\n" + .' "N": 10,'."\n" + .' "Tolerability": 169'."\n" + .' } '."\n" + .' ] '."\n" + .' }', 'title' => ''], + ], + [ + 'name' => 'AlertCheckType', + 'in' => 'formData', + 'schema' => ['description' => 'The check type for a Prometheus monitoring alert rule.'."\n" + ."\n" + .'- `STATIC`: A static threshold. The **MetricsKey** parameter is required. For more information, see the description of the **MetricsKey** parameter below.'."\n" + ."\n" + .'- `CUSTOM`: A custom PromQL query. The **PromQL**, **Duration**, and **Message** parameters are required.', 'type' => 'string', 'required' => false, 'example' => 'STATIC', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The cluster ID for the Prometheus monitoring alert rule.', 'type' => 'string', 'required' => false, 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', 'title' => ''], + ], + [ + 'name' => 'AlertGroup', + 'in' => 'formData', + 'schema' => ['description' => 'The alert group ID for the Prometheus alert rule. Valid values:'."\n" + ."\n" + .'- `-1`: Custom PromQL'."\n" + ."\n" + .'- `1`: Kubernetes workloads'."\n" + ."\n" + .'- `15`: Kubernetes nodes', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1', 'title' => ''], + ], + [ + 'name' => 'PromQL', + 'in' => 'formData', + 'schema' => ['description' => 'The PromQL expression to evaluate.', 'type' => 'string', 'required' => false, 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', 'title' => ''], + ], + [ + 'name' => 'Duration', + 'in' => 'formData', + 'schema' => ['description' => 'The period, in minutes, that a condition must be true before a Prometheus alert is triggered. Valid values: 0 to 1440.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Level', + 'in' => 'formData', + 'schema' => ['description' => 'The severity level for the Prometheus alert rule.'."\n" + ."\n" + .'- `P1`: Critical. For major issues that affect core business availability with a wide impact and severe consequences.'."\n" + ."\n" + .'- `P2`: Warning. For issues that cause partial service failures or affect system availability with a limited scope.'."\n" + ."\n" + .'- `P3`: Info. For potential issues or alerts from non-critical services.'."\n" + ."\n" + .'- `P4`: Low priority. Used for informational alerts that require attention but do not affect services.'."\n" + ."\n" + .'- `Default`: The default level, used when no specific severity is required.', 'type' => 'string', 'required' => false, 'example' => 'P2', 'title' => ''], + ], + [ + 'name' => 'Message', + 'in' => 'formData', + 'schema' => ['description' => 'The alert message for the Prometheus alert rule.', 'type' => 'string', 'required' => false, 'example' => '命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\"%.2f\\\\\\" $value }}%', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'formData', + 'schema' => ['description' => 'Labels to add to the Prometheus alert rule. Specify as a JSON string representing an array of objects, each with Name and Value keys.', 'type' => 'string', 'required' => false, 'example' => '[ { "Value": "cms_polardb", "Name": "_aliyun_cloud_product" } ]', 'title' => ''], + ], + [ + 'name' => 'Annotations', + 'in' => 'formData', + 'schema' => ['description' => 'Annotations to add to the Prometheus alert rule. Specify as a JSON string representing an array of objects, each with Name and Value keys.', 'type' => 'string', 'required' => false, 'example' => '[ { "Value": "PolarDB 慢查询数量", "Name": "_aliyun_display_name" }', 'title' => ''], + ], + [ + 'name' => 'MetricsKey', + 'in' => 'formData', + 'schema' => ['description' => 'The alert metric. This parameter is required for Prometheus alert rules when **AlertCheckType** is **STATIC**.'."\n" + ."\n" + .'> The available alert metrics vary based on the value of **AlertGroup**. For information about the mapping between **AlertGroup** and **MetricsKey**, see the supplementary information below this table.', 'type' => 'string', 'required' => false, 'example' => 'pop.status.error', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", - 'type' => 'string', + 'description' => 'The tags to add to the alert rule. These are standard Alibaba Cloud resource tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'owner', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'John', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'rg-acfmxyexli2****', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Tags', - 'in' => 'query', + 'name' => 'MarkTags', + 'in' => 'formData', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags that you want to add to the task.'."\n", + 'description' => 'Application tags used to filter applications in application monitoring alert rules.', 'type' => 'array', 'items' => [ + 'description' => 'An application tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'service', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'proudct', 'title' => ''], ], 'required' => false, - 'description' => '', + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 21, + 'maxItems' => 100, + 'title' => '', + 'example' => '', + ], + ], + [ + 'name' => 'DataConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The data configuration. The dataRevision field specifies how to handle missing metric data.'."\n" + ."\n" + .'- `0`: Fills the data with 0.'."\n" + ."\n" + .'- `1`: Fills the data with 1.'."\n" + ."\n" + .'- `2`: Fills the data with null. This is the default and does not trigger an alert.', 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "dataRevision": 2'."\n" + .'}', 'title' => ''], + ], + [ + 'name' => 'Notice', + 'in' => 'formData', + 'schema' => ['description' => 'The effective time and notification time. Used for compatibility with legacy alert rules.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], + [ + 'name' => 'AlertPiplines', + 'in' => 'formData', + 'schema' => ['description' => 'The alert pipeline configuration. Used for compatibility with legacy alert rules.', 'type' => 'string', 'required' => false, 'example' => '-', 'title' => ''], + ], + [ + 'name' => 'NotifyMode', + 'in' => 'formData', + 'schema' => [ + 'description' => 'The notification mode. Valid values:'."\n" + ."\n" + .'- `DIRECTED_MODE`: Directed mode.'."\n" + ."\n" + .'- `NORMAL_MODE`: Normal mode.', + 'enumValueTitles' => [], + 'type' => 'string', + 'example' => 'NORMAL_MODE', + 'default' => 'NORMAL_MODE', + 'enum' => ['DIRECTED_MODE', 'NORMAL_MODE'], + 'required' => false, + 'title' => '', ], ], + [ + 'name' => 'Product', + 'in' => 'formData', + 'schema' => ['description' => 'Required for Prometheus alert rules. Used to filter by cloud service. The specified product name must be valid.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'clickhouse'], + ], + [ + 'name' => 'AutoAddTargetConfig', + 'in' => 'formData', + 'schema' => ['description' => 'The configuration for automatically adding applications to an application monitoring alert rule. Specify this parameter as a JSON string with the following fields:'."\n" + ."\n" + .'- `autoAddMatchType`: The matching method. Can be `REGULAR` (matches the regular expression) or `NOT_REGULAR` (does not match the regular expression).'."\n" + ."\n" + .' Match type: Regular expression match (REGULAR) / Not a regular expression match (NOT\\_REGULAR)'."\n" + ."\n" + .'- `autoAddMatchExp`: The regular expression.', 'type' => 'string', 'required' => false, 'example' => '{\\"autoAddMatchType\\":\\"REGULAR\\",\\"autoAddMatchExp\\":\\".*cbw.*\\"}', 'title' => ''], + ], + [ + 'name' => 'CheckCycle', + 'in' => 'formData', + 'schema' => ['description' => 'The check interval for the Prometheus alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'formData', + 'schema' => ['description' => 'The language of the response.', 'type' => 'string', 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The response parameters.', - 'type' => 'string', - 'example' => 'bdidt76ehx@d5cf1cd3f7df411', - ], - 'Success' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'- true: The call was successful.'."\n" - .'- false: The call failed.', - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => 'The message returned.', - 'type' => 'string', - 'example' => 'success', - ], - 'RetcodeAppDataBean' => [ - 'description' => 'The information of the Browser Monitoring task.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******'], + 'AlertRule' => [ + 'description' => 'The alert rule object.', 'type' => 'object', 'properties' => [ - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'aokcdqn3ly@a195c6d6421****', - ], - 'AppId' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '135143', + 'AlertId' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '5510445', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'title' => '', 'example' => 'arms-test'], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'title' => '', 'example' => '1131971649******'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'AlertType' => ['description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'- `APPLICATION_MONITORING_ALERT_RULE`: an alert rule for application monitoring.'."\n" + ."\n" + .'- `BROWSER_MONITORING_ALERT_RULE`: an alert rule for browser monitoring.'."\n" + ."\n" + .'- `PROMETHEUS_MONITORING_ALERT_RULE`: an alert rule for Prometheus monitoring.', 'type' => 'string', 'title' => '', 'example' => 'APPLICATION_MONITORING_ALERT_RULE'], + 'AlertStatus' => ['description' => 'The status of the alert rule.'."\n" + ."\n" + .'- `RUNNING`: The alert rule is running.'."\n" + ."\n" + .'- `STOPPED`: The alert rule is stopped.'."\n" + ."\n" + .'- `PAUSED`: The alert rule is paused.'."\n" + ."\n" + .'> The `PAUSED` status indicates that the system has automatically suspended the alert rule due to an abnormality. This can happen if the alert rule generates too many distinct time series or its associated cluster is deleted.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'CreatedTime' => ['description' => 'The UNIX timestamp, in milliseconds, when the alert rule was created.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1641438611000'], + 'UpdatedTime' => ['description' => 'The UNIX timestamp, in milliseconds, when the alert rule was last updated.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1641438611000'], + 'Extend' => ['description' => 'The extended fields, returned as a JSON string.', 'type' => 'string', 'title' => '', 'example' => '{\\"alarmContext\\":\\"{\\\\\\"content\\\\\\":\\\\\\"报警名称:$报警名称\\\\\\\\n筛选条件: $筛选\\\\\\\\n报警时间: $报警时间\\\\\\\\n报警内容: $报警内容\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\",\\\\\\"subTitle\\\\\\":\\\\\\"\\\\\\"}\\",\\"alertWays\\":\\"[0,1]\\",\\"contactGroupIds\\":\\"381,5075\\",\\"notice\\":\\"{\\\\\\"endTime\\\\\\":1480607940000,\\\\\\"noticeEndTime\\\\\\":1480607940000,\\\\\\"noticeStartTime\\\\\\":1480521600000,\\\\\\"startTime\\\\\\":1480521600000}\\"}'], + 'NotifyStrategy' => ['description' => 'The notification policy.', 'type' => 'string', 'title' => '', 'example' => 'ALERT_MANAGER'], + 'Pids' => [ + 'title' => '', + 'description' => 'The PIDs of the applications associated with the alert rule. This applies to application monitoring and browser monitoring rules.', + 'type' => 'array', + 'items' => ['description' => 'The PID of the application.', 'type' => 'string', 'example' => 'b590lhguqs@40d8deedfa9******', 'title' => ''], + 'example' => '', ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', + 'AutoAddNewApplication' => ['description' => 'Indicates whether newly created applications are automatically added to the alert rule. This applies to application monitoring and browser monitoring rules.'."\n" + ."\n" + .'- `true`: Enabled'."\n" + ."\n" + .'- `false`: Disabled', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'MetricsType' => ['description' => 'The metric type of the alert rule. This applies to application monitoring and browser monitoring.', 'type' => 'string', 'title' => '', 'example' => 'JVM'], + 'AlertRuleContent' => [ + 'title' => '', + 'description' => 'The content of the alert rule. This applies to application monitoring and browser monitoring.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The logical operator for combining multiple alert conditions. This applies to application monitoring and browser monitoring.'."\n" + ."\n" + .'- `OR`: The alert is triggered if any condition is met.'."\n" + ."\n" + .'- `AND`: The alert is triggered only if all conditions are met.', 'type' => 'string', 'title' => '', 'example' => 'OR'], + 'AlertRuleItems' => [ + 'title' => '', + 'description' => 'The alert conditions. This applies to application monitoring and browser monitoring alert rules.', + 'type' => 'array', + 'items' => [ + 'description' => 'An alert condition object.', + 'type' => 'object', + 'properties' => [ + 'N' => ['description' => 'The duration of the time window, in minutes, for evaluating the alert condition.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '1'], + 'MetricKey' => ['description' => 'The metric that is evaluated by the alert condition.', 'type' => 'string', 'title' => '', 'example' => 'JVM非堆总使用内存量'], + 'Aggregate' => ['description' => 'The aggregation method for the alert condition.'."\n" + ."\n" + .'- `AVG`: average'."\n" + ."\n" + .'- `SUM`: sum'."\n" + ."\n" + .'- `MAX`: maximum'."\n" + ."\n" + .'- `MIN`: minimum', 'type' => 'string', 'title' => '', 'example' => 'AVG'], + 'Operator' => ['description' => 'The operator used to compare the aggregated metric value with the threshold.'."\n" + ."\n" + .'- `CURRENT_GTE`: greater than or equal to'."\n" + ."\n" + .'- `CURRENT_LTE`: less than or equal to'."\n" + ."\n" + .'- `PREVIOUS_UP`: period-over-period increase percentage'."\n" + ."\n" + .'- `PREVIOUS_DOWN`: period-over-period decrease percentage'."\n" + ."\n" + .'- `HOH_UP`: hour-over-hour increase percentage'."\n" + ."\n" + .'- `HOH_DOWN`: hour-over-hour decrease percentage'."\n" + ."\n" + .'- `DOD_UP`: day-over-day increase percentage'."\n" + ."\n" + .'- `DOD_DOWN`: day-over-day decrease percentage', 'type' => 'string', 'title' => '', 'example' => 'CURRENT_GTE'], + 'Value' => ['description' => 'The threshold for the alert condition.', 'type' => 'string', 'title' => '', 'example' => '1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'Tags' => [ + 'Filters' => [ + 'title' => '', + 'description' => 'The filters of the alert rule. This applies to application monitoring or browser monitoring.', 'type' => 'object', - 'itemNode' => true, 'properties' => [ - 'Tags' => [ - 'description' => 'The tags of the task.'."\n", + 'DimFilters' => [ + 'description' => 'The filter conditions of the alert rule. This applies to application monitoring or browser monitoring.', 'type' => 'array', 'items' => [ + 'description' => 'A filter condition object.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', + 'FilterKey' => ['description' => 'The key of the filter condition.', 'type' => 'string', 'example' => 'rootIp', 'title' => ''], + 'FilterOpt' => ['description' => 'The operator for the filter condition.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'FilterValues' => [ + 'description' => 'The values for the filter condition.', + 'type' => 'array', + 'items' => ['description' => 'A value for the filter condition.', 'type' => 'string', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'CustomSLSFilters' => [ + 'description' => 'The custom filter conditions for the browser monitoring alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'A custom filter condition object.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the filter condition.', 'type' => 'string', 'example' => 'username', 'title' => ''], + 'Opt' => ['description' => 'The operator for the filter condition.'."\n" + ."\n" + .'- `=`: equals'."\n" + ."\n" + .'- `not`: not equal to', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Value' => ['description' => 'The value for the filter condition.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'T' => ['description' => 'Used exclusively to distinguish between log types in browser monitoring. This parameter does not apply to other filter conditions.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Show' => ['description' => 'Indicates whether the filter condition is displayed on the console.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CustomSLSGroupByDimensions' => [ + 'description' => 'The aggregation dimensions.', + 'type' => 'array', + 'items' => ['description' => 'An aggregation dimension.', 'type' => 'string', 'example' => '["page"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'CustomSLSWheres' => [ + 'description' => 'The configured filter conditions.', + 'type' => 'array', + 'items' => ['description' => 'A configured filter condition.', 'type' => 'string', 'example' => '["t like \'%api%\'"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'AlertCheckType' => ['description' => 'The check type of the Prometheus alert rule.'."\n" + ."\n" + .'- `STATIC`: The alert is triggered based on a static threshold.'."\n" + ."\n" + .'- `CUSTOM`: The alert is triggered based on a custom PromQL expression.', 'type' => 'string', 'title' => '', 'example' => 'STATIC'], + 'ClusterId' => ['description' => 'The ID of the cluster that is associated with the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => 'ceba9b9ea5b924dd0b6726d2de6******'], + 'AlertGroup' => ['description' => 'The alert group for the Prometheus alert rule.'."\n" + ."\n" + .'- `-1`: Custom PromQL'."\n" + ."\n" + .'- `1`: Kubernetes Workloads'."\n" + ."\n" + .'- `15`: Kubernetes Nodes', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '-1'], + 'PromQL' => ['description' => 'The PromQL expression for the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100'], + 'Duration' => ['description' => 'The duration, in minutes, for which a condition must be true before an alert is triggered. This applies only to Prometheus alert rules.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Level' => ['description' => 'The severity level of the Prometheus alert rule.'."\n" + ."\n" + .'- `P1`: Critical. Indicates major issues that affect core business availability and can have severe consequences.'."\n" + ."\n" + .'- `P2`: Warning. Indicates issues that impact system availability but have a limited scope.'."\n" + ."\n" + .'- `P3`: Info. Indicates potential issues or alerts from less critical services.'."\n" + ."\n" + .'- `P4`: Low priority. Indicates informational alerts that do not affect services.'."\n" + ."\n" + .'- `Default`: The default level used when no specific severity is required.', 'type' => 'string', 'title' => '', 'example' => 'P2'], + 'Message' => ['description' => 'The message of the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => '命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\"%.2f\\\\\\" $value }}%'], + 'Labels' => [ + 'title' => '', + 'description' => 'The labels of the Prometheus alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'A label object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The label key.', 'type' => 'string', 'title' => '', 'example' => '123'], + 'Value' => ['description' => 'The label value.', 'type' => 'string', 'title' => '', 'example' => 'abc'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Annotations' => [ + 'title' => '', + 'description' => 'The annotations of the Prometheus alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'An annotation object.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The annotation key.', 'type' => 'string', 'title' => '', 'example' => '123'], + 'Value' => ['description' => 'The annotation value.', 'type' => 'string', 'title' => '', 'example' => 'abc'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'Tags' => [ + 'description' => 'The tags that are added to the alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'A tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'owner', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'John', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'NotifyMode' => ['description' => 'The notification mode.', 'type' => 'string', 'example' => 'NORMAL_MODE', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"bdidt76ehx@d5cf1cd3f7df411\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RetcodeAppDataBean\\": {\\n \\"Pid\\": \\"aokcdqn3ly@a195c6d6421****\\",\\n \\"AppId\\": 135143,\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Tags\\": {\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRetcodeAppResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C647A</RequestId>\\n <RetcodeAppDataBean>\\n <AppId>135143</AppId>\\n <Pid>aokcdqn3ly@a195c6d6421****</Pid>\\n </RetcodeAppDataBean>\\n</CreateRetcodeAppResponse>","errorExample":""}]', - 'title' => 'CreateRetcodeApp', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetRetcodeShareUrl' => [ - 'methods' => [ - 'post', - 'get', + 'title' => 'CreateOrUpdateAlertRule', + 'requestParamsDescription' => '### **AlertRuleContent** parameters'."\n" + ."\n" + .'```'."\n" + .'{ '."\n" + .' "Condition": "OR",'."\n" + .' "AlertRuleItems": ['."\n" + .' { "Operator": "CURRENT_LTE",'."\n" + .' "MetricKey": "appstat.jvm.threadcount",'."\n" + .' "Value": 1000,'."\n" + .' "Aggregate": "AVG",'."\n" + .' "N": 10,'."\n" + .' "Tolerability": 169'."\n" + .' } '."\n" + .' ] '."\n" + .' }'."\n" + .'```'."\n" + ."\n" + .'- Condition: Defines the trigger logic for multiple alert conditions.'."\n" + ."\n" + .' - OR: The alert triggers if any specified condition is met.'."\n" + ."\n" + .' - AND: The alert triggers if all specified conditions are met.'."\n" + ."\n" + .'- Operator: The comparison operator for an alert condition.'."\n" + ."\n" + .' - CURRENT\\_GTE: Greater than or equal to'."\n" + ."\n" + .' - CURRENT\\_LTE: Less than or equal to'."\n" + ."\n" + .' - PREVIOUS\\_UP: Period-over-period percentage increase'."\n" + ."\n" + .' - PREVIOUS\\_DOWN: Period-over-period percentage decrease'."\n" + ."\n" + .' - HOH\\_UP: Hour-over-hour percentage increase'."\n" + ."\n" + .' - HOH\\_DOWN: Hour-over-hour percentage decrease'."\n" + ."\n" + .' - DOD\\_UP: Day-over-day percentage increase'."\n" + ."\n" + .' - DOD\\_DOWN: Day-over-day percentage decrease'."\n" + ."\n" + .' - INTERVAL\\_EXCEED: Interval detection. Note that this operator does not support multiple conditions.'."\n" + ."\n" + .'- MetricKey: The metric for the alert condition. The available metrics depend on the **MetricsType**. For mappings, see the tables below.'."\n" + ."\n" + .'- Value: The alert threshold.'."\n" + ."\n" + .'- Aggregate: The aggregation method for the metric.'."\n" + ."\n" + .' - AVG: Average'."\n" + ."\n" + .' - SUM: Sum'."\n" + ."\n" + .' - MAX: Maximum value'."\n" + ."\n" + .' - MIN: Minimum value'."\n" + ."\n" + .' - CONTINUOUS: Continuous'."\n" + ."\n" + .' - AVG\\_WEIGHTED: Weighted average of the error rate'."\n" + ."\n" + .'- N: The aggregation time window in minutes.'."\n" + ."\n" + .'- Tolerability: The interval tolerance. The value must be an integer from 1 to 200.'."\n" + ."\n" + .'### Application monitoring: MetricsType and MetricKey mappings'."\n" + ."\n" + .'| MetricsType | Type | AlertRuleContent.AlertRuleItems.MetricKey |'."\n" + .'| ----------- | -------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| jvm | JVM monitoring | \\- appstat.jvm.gc.oldgccountinstant: JVM FullGC count (instantaneous)<br>\\- appstat.jvm.gc.oldgctimeinstant: JVM FullGC time (instantaneous)<br>\\- appstat.jvm.gc.younggccountinstant: JVM YoungGC count (instantaneous)<br>\\- appstat.jvm.gc.younggctimeinstant: JVM YoungGC time (instantaneous)<br>\\- appstat.jvm.heap_total: Total JVM heap memory<br>\\- appstat.jvm.heap_used: Used JVM heap memory<br>\\- appstat.jvm.non_heap_committed: Committed JVM non-heap memory<br>\\- appstat.jvm.non_heap_init: Initial JVM non-heap memory<br>\\- appstat.jvm.non_heap_max: Maximum JVM non-heap memory<br>\\- appstat.jvm.non_heap_used: Total used JVM non-heap memory<br>\\- appstat.jvm.threadblockedcount: Number of blocked JVM threads<br>\\- appstat.jvm.threadcount: Total number of JVM threads<br>\\- appstat.jvm.threaddeadlockcount: Number of deadlocked JVM threads<br>\\- appstat.jvm.threadnewcount: Number of new JVM threads<br>\\- appstat.jvm.threadrunnablecount: Number of runnable JVM threads<br>\\- appstat.jvm.threadterminatedcount: Number of terminated JVM threads<br>\\- appstat.jvm.threadtimedwaitcount: Number of timed-waiting JVM threads<br>\\- appstat.jvm.threadwaitcount: Number of waiting JVM threads |'."\n" + .'| saehost | SAE host monitoring | \\- appstat.infra.sae.systemcpu: CPU usage<br>\\- appstat.infra.sae.systemdiskiopsread: Disk read IOPS<br>\\- appstat.infra.sae.systemdiskiopswrite: Disk write IOPS<br>\\- appstat.infra.sae.systemdiskrate: Disk usage rate<br>\\- appstat.infra.sae.systemdiskread: Disk read I/O throughput<br>\\- appstat.infra.sae.systemdisktotal: Total disk space<br>\\- appstat.infra.sae.systemdiskused: Used disk space<br>\\- appstat.infra.sae.systemdiskwrite: Disk write I/O throughput<br>\\- appstat.infra.sae.systemload: System load<br>\\- appstat.infra.sae.systemmemrate: Memory usage rate<br>\\- appstat.infra.sae.systemmemtotal: Total memory<br>\\- appstat.infra.sae.systemmemused: Used memory<br>\\- appstat.infra.sae.systemnetrecv: Network inbound bytes<br>\\- appstat.infra.sae.systemnetrecvdrop: Network inbound dropped packets<br>\\- appstat.infra.sae.systemnetrecverror: Network inbound error packets<br>\\- appstat.infra.sae.systemnetrecvpacket: Network inbound packets<br>\\- appstat.infra.sae.systemnettran: Network outbound bytes<br>\\- appstat.infra.sae.systemnettrandrop: Network outbound dropped packets<br>\\- appstat.infra.sae.systemnettranerror: Network outbound error packets<br>\\- appstat.infra.sae.systemnettranpacket: Network outbound packets |'."\n" + .'| txn_db | SQL metrics | \\- appstat.sql.count: Number of database calls<br>\\- appstat.sql.error: Number of database call errors<br>\\- appstat.sql.rt: Database call response time |'."\n" + .'| db | Database metrics | \\- appstat.database.count: Number of database calls<br>\\- appstat.database.errcount: Number of database call errors<br>\\- appstat.database.rt: Database call response time |'."\n" + .'| threadpool | Thread pool monitoring | \\- appstat.threadpool.threadcorepoolsize: Core pool size<br>\\- appstat.threadpool.threadmaxpoolsize: Maximum pool size<br>\\- appstat.threadpool.threadpoolactivecount: Active thread count<br>\\- appstat.threadpool.threadpoolqueuesize: Queue size<br>\\- appstat.threadpool.threadpoolsize: Current pool size<br>\\- appstat.threadpool.threadpooltaskcount: Completed task count<br>\\- appstat.threadpool.threadpoolusedpercent: Thread pool usage rate |'."\n" + .'| exception | Interface call exceptions | \\- appstat.exception.count: Number of errored application interface calls<br>\\- appstat.exception.rt: Response time of errored application interface calls |'."\n" + .'| txn_type | Statistics for dependent services | \\- appstat.outcall.count: Number of calls to application dependencies<br>\\- appstat.outcall.errorrate: Error rate of calls to application dependencies<br>\\- appstat.outcall.rt: Response time of calls to application dependencies |'."\n" + .'| txn | Statistics for application-provided services | \\- appstat.transaction.count: Number of calls<br>\\- appstat.transaction.error: Number of call errors<br>\\- appstat.transaction.errorrate: Call error rate<br>\\- appstat.transaction.rt: Call response time |'."\n" + .'| host | Host monitoring | \\- appstat.jvm.systemcpuusage: Node CPU usage rate<br>\\- appstat.jvm.systemcpuuser: Node CPU user-space utilization rate<br>\\- appstat.jvm.systemdiskfree: Free disk space on the node<br>\\- appstat.jvm.systemdiskusage: Node disk usage rate<br>\\- appstat.jvm.systemload: Node system load<br>\\- appstat.jvm.systemmemfree: Free memory on the node<br>\\- appstat.jvm.systemmemusage: Node memory usage rate<br>\\- appstat.jvm.systemnetinerrs: Number of inbound error packets on the node<br>\\- appstat.jvm.systemnetouterrs: Number of outbound error packets on the node |'."\n" + .'| scheduler | Scheduled tasks | \\- appstat.scheduler.rt: Execution time<br>\\- appstat.scheduler.count: Number of executions<br>\\- appstat.scheduler.error: Number of execution exceptions<br>\\- appstat.scheduler.delay: Scheduling delay time |'."\n" + ."\n" + .'### Frontend monitoring: MetricsType and MetricKey mappings'."\n" + ."\n" + .'| MetricsType | Type | AlertRuleContent.AlertRuleItems.MetricKey |'."\n" + .'| ----------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| api | API metrics | \\- webstat.api.detail.count: Number of API requests<br>\\- webstat.api.detail.fail_time: API failure duration<br>\\- webstat.api.detail.fail_uv: Number of users affected by API errors<br>\\- webstat.api.detail.success_rate: API success rate<br>\\- webstat.api.detail.success_time: API success duration |'."\n" + .'| page.api | Page API metrics | \\- webstat.api.detail.page_api.count: Number of API requests<br>\\- webstat.api.detail.page_api.fail_time: API failure duration<br>\\- webstat.api.detail.page_api.success_rate: API success rate<br>\\- webstat.api.detail.page_api.success_time: API success duration |'."\n" + .'| page | Page metrics | \\- webstat.api.detail.page_api.fail_uv: Number of users affected by API errors<br>\\- webstat.index.pv: Page views (PV)<br>\\- webstat.jserror.count: Number of JS errors<br>\\- webstat.jserror.rate: JS error rate<br>\\- webstat.msg.top.error_uv: Number of users affected by JS errors<br>\\- webstat.resource.sum: Number of resource errors<br>\\- webstat.satisfy.satisfy: Page satisfaction score<br>\\- webstat.speed.avg_cfpt: Page custom first paint time<br>\\- webstat.speed.avg_ctti: Page custom time to interactive<br>\\- webstat.speed.avg_dns: Page DNS lookup time<br>\\- webstat.speed.avg_dom: Page DOM parsing time<br>\\- webstat.speed.avg_fmp: Page first meaningful paint (FMP)<br>\\- webstat.speed.avg_fpt: Page first paint time (FPT)<br>\\- webstat.speed.avg_load: Page load time<br>\\- webstat.speed.avg_ready: Ready time<br>\\- webstat.speed.avg_res: Page resource load time<br>\\- webstat.speed.avg_ssl: Page SSL connection time<br>\\- webstat.speed.avg_t1: Page custom t1 time<br>\\- webstat.speed.avg_t10: Page custom t10 time<br>\\- webstat.speed.avg_t2: Page custom t2 time<br>\\- webstat.speed.avg_t3: Page custom t3 time<br>\\- webstat.speed.avg_t4: Page custom t4 time<br>\\- webstat.speed.avg_t5: Page custom t5 time<br>\\- webstat.speed.avg_t6: Page custom t6 time<br>\\- webstat.speed.avg_t7: Page custom t7 time<br>\\- webstat.speed.avg_t8: Page custom t8 time<br>\\- webstat.speed.avg_t9: Page custom t9 time<br>\\- webstat.speed.avg_tcp: Page TCP connection time<br>\\- webstat.speed.avg_trans: Page content transfer time<br>\\- webstat.speed.avg_ttfb: Page time to first byte (TTFB)<br>\\- webstat.speed.avg_tti: Page time to interactive (TTI) |'."\n" + .'| custom | Custom metrics | \\- webstat.avg.avg_val: Custom reported average value<br>\\- webstat.sum.sum_val: Custom reported sum |'."\n" + ."\n" + .'### Prometheus monitoring: AlertGroup and MetricsKey mappings'."\n" + ."\n" + .'| AlertGroup | Alert group | MetricsKey |'."\n" + .'| ---------- | ------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| 1 | Kubernetes workload | \\- prom.workload.container_cpu_usage: Container CPU usage rate<br>\\- prom.workload.job_execute_error: Job execution failure<br>\\- prom.workload.pod_cpu_usage: Pod CPU usage<br>\\- prom.workload.pod_start_timeout: Pod start timeout failure<br>\\- prom.workload.pod_restart_frequent: Frequent pod restarts<br>\\- prom.workload.pod_status_error: Abnormal pod status<br>\\- prom.workload.container_memory_usage: Container memory usage rate<br>\\- prom.workload.deployment_pod_survival: Deployment pod availability rate |'."\n" + .'| 15 | Kubernetes node | \\- prom.node.node_memory_usage: Node memory usage rate<br>\\- prom.node.node_cpu_usage: Node CPU usage rate<br>\\- prom.node.node_disk_usage: Node disk usage rate<br>\\- prom.node.node_status_error: Abnormal node status |', + 'changeSet' => [ + ['createdAt' => '2025-02-13T10:21:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-27T03:45:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-07T07:29:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-29T05:41:34.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-18T08:13:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-20T04:58:30.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-17T11:36:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-16T10:02:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-11T08:08:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-14T12:59:57.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-24T05:40:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-11T12:16:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-02T08:42:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-22T06:04:04.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateAlertRule'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateAlertRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:alertrule/{#AlertRuled}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337B8F7E-0A64-5768-9225-E9B3CF******\\",\\n \\"AlertRule\\": {\\n \\"AlertId\\": 5510445,\\n \\"AlertName\\": \\"arms-test\\",\\n \\"UserId\\": \\"1131971649******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AlertType\\": \\"APPLICATION_MONITORING_ALERT_RULE\\",\\n \\"AlertStatus\\": \\"RUNNING\\",\\n \\"CreatedTime\\": 1641438611000,\\n \\"UpdatedTime\\": 1641438611000,\\n \\"Extend\\": \\"{\\\\\\\\\\\\\\"alarmContext\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"报警名称:$报警名称\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n筛选条件: $筛选\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警时间: $报警时间\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警内容: $报警内容\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"subTitle\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alertWays\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[0,1]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"contactGroupIds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"381,5075\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"notice\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeEndTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeStartTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000}\\\\\\\\\\\\\\"}\\",\\n \\"NotifyStrategy\\": \\"ALERT_MANAGER\\",\\n \\"Pids\\": [\\n \\"b590lhguqs@40d8deedfa9******\\"\\n ],\\n \\"AutoAddNewApplication\\": false,\\n \\"MetricsType\\": \\"JVM\\",\\n \\"AlertRuleContent\\": {\\n \\"Condition\\": \\"OR\\",\\n \\"AlertRuleItems\\": [\\n {\\n \\"N\\": 1,\\n \\"MetricKey\\": \\"JVM非堆总使用内存量\\",\\n \\"Aggregate\\": \\"AVG\\",\\n \\"Operator\\": \\"CURRENT_GTE\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"Filters\\": {\\n \\"DimFilters\\": [\\n {\\n \\"FilterKey\\": \\"rootIp\\",\\n \\"FilterOpt\\": \\"ALL\\",\\n \\"FilterValues\\": [\\n \\"[]\\"\\n ]\\n }\\n ],\\n \\"CustomSLSFilters\\": [\\n {\\n \\"Key\\": \\"username\\",\\n \\"Opt\\": \\"=\\",\\n \\"Value\\": \\"test\\",\\n \\"T\\": \\"null\\",\\n \\"Show\\": false\\n }\\n ],\\n \\"CustomSLSGroupByDimensions\\": [\\n \\"[\\\\\\"page\\\\\\"]\\"\\n ],\\n \\"CustomSLSWheres\\": [\\n \\"[\\\\\\"t like \'%api%\'\\\\\\"]\\"\\n ]\\n },\\n \\"AlertCheckType\\": \\"STATIC\\",\\n \\"ClusterId\\": \\"ceba9b9ea5b924dd0b6726d2de6******\\",\\n \\"AlertGroup\\": -1,\\n \\"PromQL\\": \\"node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100\\",\\n \\"Duration\\": \\"1\\",\\n \\"Level\\": \\"P2\\",\\n \\"Message\\": \\"命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"%.2f\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\" $value }}%\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"owner\\",\\n \\"Value\\": \\"John\\"\\n }\\n ],\\n \\"NotifyMode\\": \\"NORMAL_MODE\\"\\n }\\n}","type":"json"}]', + ], + 'CreateOrUpdateContact' => [ + 'summary' => 'Creates or modifies an alert contact.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6667,173 +3698,296 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the alert contact.'."\n" + ."\n" + .'* If you do not specify this parameter, a new alert contact is created.'."\n" + .'* If you specify this parameter, the specified alert contact is modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + ], + [ + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'required' => true, 'example' => 'JohnDoe'], + ], + [ + 'name' => 'Phone', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The mobile number of the alert contact.'."\n" + ."\n" + .'> You must specify at least one of the **Phone** and **Email** parameters. Each mobile number or email address can be used for only one alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => '1381111****'], + ], + [ + 'name' => 'Email', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The email address of the alert contact.'."\n" + ."\n" + .'> You must specify at least one of the **Phone** and **Email** parameters. Each mobile number or email address can be used for only one alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => 'someone@example.com'], + ], + [ + 'name' => 'ReissueSendNotice', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The operation that you want to perform if phone calls fail to be answered. Valid values:'."\n" + ."\n" + .'* 0: No operation is performed.'."\n" + .'* 1: A phone call is made again.'."\n" + .'* 2: A text message is sent.'."\n" + .'* 3 (default value): The global default value is used.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3'], + ], + [ + 'name' => 'IsEmailVerify', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether the email address is verified.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'DingRobotUrl', 'in' => 'query', - 'schema' => [ - 'description' => 'The project ID (PID) of the application.'."\n" - ."\n" - .'To obtain the application PID, log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Browser Monitoring**>**Browser Monitoring**. Then, click the name of the application. The URL in the address bar contains the application PID, in the xxx format. As the browser is encoded, you must modify the PID. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with an at sign (@) to obtain xxx@74xxx.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'iioe7jcnuk@582846f37******', - ], + 'schema' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=69d4e0******', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'CorpUserId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the alert contact that is shown to the enterprise when the contact is mentioned with the at sign (@) by a third-party instant messaging (IM) tool.'."\n", 'type' => 'string', 'required' => false, 'example' => 'A123221', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Url' => [ - 'description' => 'The share URL of the application monitored by Browser Monitoring.'."\n", - 'type' => 'string', - 'example' => 'http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '01FF8DD9-A09C-47A1-895A-B6E321******', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****'], + 'AlertContact' => [ + 'description' => 'The object of the alert contact.'."\n", + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The ID of the alert contact.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'ContactName' => ['title' => '', 'description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'example' => 'JohnDoe'], + 'Phone' => ['title' => '', 'description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'example' => '1381111****'], + 'Email' => ['title' => '', 'description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'example' => 'someone@example.com'], + 'IsVerify' => ['title' => '', 'description' => 'Indicates whether the mobile number was verified. Valid values:'."\n" + ."\n" + .'* `false` (default value): No'."\n" + .'* `true`: Yes'."\n" + ."\n" + .'You can call the **SendTTSVerifyLink** operation to verify the mobile number of an alert contact. Only verified mobile numbers can be specified in a notification policy to receive phone calls.'."\n", 'type' => 'boolean', 'example' => 'false'], + 'ReissueSendNotice' => ['title' => '', 'description' => 'The operation that you want to perform if phone calls fail to be answered. Valid values: 0: No operation is performed. 1: A phone call is made again. 2: A text message is sent. 3 (default value): The global default value is used.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'isEmailVerify' => ['description' => 'Indicates whether the email address was verified.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DingRobotUrl' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n", 'type' => 'string', 'example' => 'https://test1.com', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1\\",\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\"\\n}","errorExample":""},{"type":"xml","example":"<GetRetcodeShareUrlResponse>\\n <requestId>01FF8DD9-A09C-47A1-895A-B6E321BE77B6</requestId>\\n <url>http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1</url>\\n</GetRetcodeShareUrlResponse>","errorExample":""}]', - 'title' => 'GetRetcodeShareUrl', - 'summary' => 'Queries the share URL of an application monitored by Browser Monitoring.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteRetcodeApp' => [ - 'summary' => 'Deletes a Browser Monitoring task.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"AlertContact\\": {\\n \\"ContactId\\": 123,\\n \\"ContactName\\": \\"JohnDoe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"IsVerify\\": false,\\n \\"ReissueSendNotice\\": 3,\\n \\"isEmailVerify\\": true,\\n \\"DingRobotUrl\\": \\"https://test1.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateContactResponse>\\n <RequestId>E9C9DA3D-10FE-472E-9EEF-2D0A3E41****</RequestId>\\n <AlertContact>\\n <ContactId>123</ContactId>\\n <ContactName>JohnDoe</ContactName>\\n <Phone>1381111****</Phone>\\n <Email>someone@example.com</Email>\\n <IsVerify>false</IsVerify>\\n </AlertContact>\\n</CreateOrUpdateContactResponse>","errorExample":""}]', + 'title' => 'CreateOrUpdateContact', + 'changeSet' => [ + ['createdAt' => '2024-05-09T05:56:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-09T02:03:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-29T06:35:52.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-07T08:56:31.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-17T07:45:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-24T02:41:47.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateContact'], + ], ], + ], + 'CreateOrUpdateContactGroup' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => '1231', - ], + 'name' => 'ContactGroupId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the alert contact group.'."\n" + ."\n" + .'- If you do not specify this parameter, an alert contact group is created.'."\n" + ."\n" + .'- If you specify this parameter, the specified alert contact group is modified.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => '', 'required' => false], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'ContactGroupName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'TestGroup'], ], [ - 'name' => 'AppName', - 'in' => 'query', + 'name' => 'ContactIds', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the contact that you want to add to the contact group. Separate multiple IDs with commas (,).', 'type' => 'string', 'example' => '[1,2,3]', 'title' => '', 'required' => false], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****'], + 'AlertContactGroup' => [ + 'description' => 'The information about the alert contact group.', + 'type' => 'object', + 'properties' => [ + 'ContactGroupId' => ['description' => 'The ID of the alert contact group.', 'type' => 'number', 'format' => 'float', 'title' => '', 'example' => '123'], + 'ContactGroupName' => ['description' => 'The name of the alert contact group.', 'type' => 'string', 'title' => '', 'example' => 'TestGroup'], + 'ContactIds' => ['description' => 'The IDs of the contacts that are included in the alert contact group.', 'type' => 'string', 'title' => '', 'example' => '[1,2,3]'], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'title' => 'CreateOrUpdateContactGroup', + 'summary' => 'Creates or modifies an alert contact group.', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateContactGroup'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\",\\n \\"AlertContactGroup\\": {\\n \\"ContactGroupId\\": 123,\\n \\"ContactGroupName\\": \\"TestGroup\\",\\n \\"ContactIds\\": \\"[1,2,3]\\"\\n }\\n}","type":"json"}]', + ], + 'CreateOrUpdateEventBridgeIntegration' => [ + 'summary' => 'Creates or modifies an EventBridge integration that is used to push notifications.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Pid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'aokcdqn3ly@741623b4e91****', - ], + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the EventBridge integration.'."\n" + ."\n" + .'* If you do not specify this parameter, an EventBridge integration is created.'."\n" + .'* If you specify this parameter, the specified EventBridge integration is modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the EventBridge integration.'."\n", 'type' => 'string', 'required' => true, 'example' => 'EventBridge_Test', 'title' => ''], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the EventBridge integration.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + ], + [ + 'name' => 'Endpoint', + 'in' => 'formData', + 'schema' => ['description' => 'The public endpoint of EventBridge.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://xxxxx', 'title' => ''], + ], + [ + 'name' => 'AccessKey', + 'in' => 'formData', + 'schema' => ['description' => 'The AccessKey ID that is used to connect to EventBridge.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc******************', 'title' => ''], + ], + [ + 'name' => 'AccessSecret', + 'in' => 'formData', + 'schema' => ['description' => 'The AccessKey secret that is used to connect to EventBridge.'."\n", 'type' => 'string', 'required' => false, 'example' => 'abc******************', 'title' => ''], + ], + [ + 'name' => 'EventBusName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the event bus.'."\n", 'type' => 'string', 'required' => false, 'example' => 'EventBus_Test', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'formData', + 'schema' => ['description' => 'The event source.'."\n", 'type' => 'string', 'required' => false, 'example' => 'arms', 'title' => ''], + ], + [ + 'name' => 'EventBusRegionId', + 'in' => 'formData', + 'schema' => ['description' => 'The region ID of the event bus.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the Browser Monitoring task was deleted. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Whether the operation was successful:'."\n" - .'- `true`: The operation was successful'."\n" - .'- `false`: The operation failed', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'Additional information. The value description is as follows:'."\n" - .'- If the request is normal, return success.'."\n" - .'- If the request is abnormal, return specific abnormal information.', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2B289756-E791-5842-BCBD-AD414C******'], + 'EventBridgeIntegration' => [ + 'description' => 'The information about the EventBridge integration.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the EventBridge integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Name' => ['description' => 'The name of the EventBridge integration.'."\n", 'type' => 'string', 'example' => 'EventBridge_Test', 'title' => ''], + 'Description' => ['description' => 'The description of the EventBridge integration.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'Endpoint' => ['description' => 'The public endpoint of EventBridge.'."\n", 'type' => 'string', 'example' => 'http://xxxxx', 'title' => ''], + 'AccessKey' => ['description' => 'The AccessKey ID that is used to connect to EventBridge.'."\n", 'type' => 'string', 'example' => 'abc******************', 'title' => ''], + 'AccessSecret' => ['description' => 'The AccessKey secret that is used to connect to EventBridge.'."\n", 'type' => 'string', 'example' => 'abc******************', 'title' => ''], + 'EventBusName' => ['description' => 'The name of the event bus.'."\n", 'type' => 'string', 'example' => 'EventBus_Test', 'title' => ''], + 'Source' => ['description' => 'The event source.'."\n", 'type' => 'string', 'example' => 'arms', 'title' => ''], + 'EventBusRegionId' => ['description' => 'The region ID of the event bus.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRetcodeAppResponse>\\r\\n <data>true</data>\\r\\n <requestId>01FF8DD9-A09C-47A1-895A-B6E321BE77B6</requestId>\\r\\n</DeleteRetcodeAppResponse>","errorExample":""}]', - 'title' => 'DeleteRetcodeApp', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SetRetcodeShareStatus' => [ - 'summary' => 'Turns on or turns off logon-free sharing for an application monitored by Browser Monitoring.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B289756-E791-5842-BCBD-AD414C******\\",\\n \\"EventBridgeIntegration\\": {\\n \\"Id\\": 123,\\n \\"Name\\": \\"EventBridge_Test\\",\\n \\"Description\\": \\"test\\",\\n \\"Endpoint\\": \\"http://xxxxx\\",\\n \\"AccessKey\\": \\"abc******************\\",\\n \\"AccessSecret\\": \\"abc******************\\",\\n \\"EventBusName\\": \\"EventBus_Test\\",\\n \\"Source\\": \\"arms\\",\\n \\"EventBusRegionId\\": \\"cn-hangzhou\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateEventBridgeIntegrationResponse>\\n <RequestId>2B289756-E791-5842-BCBD-AD414C******</RequestId>\\n <EventBridgeIntegration>\\n <Id>123</Id>\\n <Name>EventBridge_Test</Name>\\n <Description>test</Description>\\n <Endpoint>http://xxxxx</Endpoint>\\n <AccessKey>abc******************</AccessKey>\\n <AccessSecret>abc******************</AccessSecret>\\n <EventBusName>EventBus_Test</EventBusName>\\n <Source>arms</Source>\\n <EventBusRegionId>cn-hangzhou</EventBusRegionId>\\n </EventBridgeIntegration>\\n</CreateOrUpdateEventBridgeIntegrationResponse>","errorExample":""}]', + 'title' => 'CreateOrUpdateEventBridgeIntegration', + 'changeSet' => [ + ['createdAt' => '2024-07-30T07:58:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-07T14:29:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateEventBridgeIntegration'], + ], ], + ], + 'CreateOrUpdateIMRobot' => [ + 'summary' => 'Creates or updates an IM chatbot.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -6843,248 +3997,567 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '118628', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'Pid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application. '."\n" - ."\n" - .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the `pid=xxx` format. The PID is usually percent encoded as `xxx%40xxx`. You must modify this value to remove the percent encoding. For example, if the PID in the URL is `eb4zdose6v%409781be0f44d****`, you must replace `%40` with @ to obtain `eb4zdose6v@9781be0f44d****`.', - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], + 'name' => 'RobotId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the IM chatbot.'."\n" + .'> If you do not specify the parameter, a new IM chatbot is created.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], ], [ - 'name' => 'Status', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to turn on or turn off the logon-free sharing switch. Valid values:'."\n" - ."\n" - .'* `true`: Turn on the switch.'."\n" - .'* `false`: Turn off the switch.'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'name' => 'RobotName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the IM chatbot.'."\n", 'type' => 'string', 'required' => true, 'example' => 'robot名称'], ], [ - 'name' => 'AppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application that is monitored by Browser Monitoring.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], + 'name' => 'Type', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The type of the IM chatbot. Valid values:'."\n" + ."\n" + .'* `dingding`: DingTalk chatbot'."\n" + .'* `wechat`: WeCom chatbot'."\n" + .'* `feishu`: Lark chatbot'."\n", 'type' => 'string', 'required' => true, 'example' => 'dingding'], + ], + [ + 'name' => 'RobotAddress', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The webhook URL of the IM chatbot.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******'], + ], + [ + 'name' => 'DailyNoc', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to send daily statistics. Valid values:'."\n" + ."\n" + .'* `false` (default): Daily statistics are not sent.'."\n" + .'* `true`: Daily statistics are sent. If you set the value to `true`, the **DailyNocTime** parameter is required.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'DailyNocTime', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The points in time at which the daily statistics are sent. Separate multiple points in time with commas (,). The points in time are in the HH:SS format. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.'."\n", 'type' => 'string', 'required' => false, 'example' => '09:30,17:00'], + ], + [ + 'name' => 'DingSignKey', + 'in' => 'formData', + 'schema' => ['description' => 'The signature key of DingTalk. If you specify a signature key, DingTalk authentication is performed by using the signature key. If you do not specify a signature key, a whitelist is used for authentication by default. The keyword of the whitelist is **Alert**.'."\n", 'type' => 'string', 'required' => false, 'example' => '******', 'title' => ''], + ], + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => ['description' => 'The token required to enable the Outgoing feature.'."\n", 'type' => 'string', 'required' => false, 'example' => '1656558719183be1245ab44********', 'title' => ''], + ], + [ + 'name' => 'EnableOutgoing', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to enable the Outgoing feature.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'CardTemplate', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The configurations of the alert card template. For more information about the parameters in the template, see the following section.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'IsSuccess' => [ - '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', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****'], + 'AlertRobot' => [ + 'description' => 'The information about the IM chatbot.'."\n", + 'type' => 'object', + 'properties' => [ + 'RobotId' => ['title' => '', 'description' => 'The ID of the IM chatbot.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'RobotName' => ['title' => '', 'description' => 'The name of the IM chatbot.'."\n", 'type' => 'string', 'example' => 'robot名称'], + 'Type' => ['title' => '', 'description' => 'The type of the IM chatbot. Valid values:'."\n" + ."\n" + .'* `dingding`: DingTalk chatbot'."\n" + .'* `wechat`: WeCom chatbot'."\n", 'type' => 'string', 'example' => 'dingding'], + 'RobotAddress' => ['title' => '', 'description' => 'The webhook URL of the IM chatbot.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******'], + 'DailyNoc' => ['title' => '', 'description' => 'Indicates whether daily statistics are sent. Valid values:'."\n" + ."\n" + .'* `false` (default): Daily statistics are not sent.'."\n" + .'* `true`: Daily statistics are sent.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'DailyNocTime' => ['title' => '', 'description' => 'The point in time at which the daily statistics are sent. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.'."\n", 'type' => 'string', 'example' => '09:30,17:00'], + 'Token' => ['description' => 'The token required to enable the Outgoing feature.'."\n", 'type' => 'string', 'example' => '1656558719183be1245ab44********'."\n", 'title' => ''], + 'EnableOutgoing' => ['description' => 'Indicates whether the Outgoing feature is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CardTemplate' => ['title' => '', 'description' => 'The configurations of the alert card template.'."\n", 'type' => 'string', 'example' => '{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }'], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetRetcodeShareStatusResponse>\\n <IsSuccess>true</IsSuccess>\\n <RequestId>40B10E04-81E8-4643-970D-F1B38F2E****</RequestId>\\n</SetRetcodeShareStatusResponse>","errorExample":""}]', - 'title' => 'SetRetcodeShareStatus', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListRetcodeApps' => [ - 'summary' => 'Queries the Browser Monitoring tasks in a region.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"AlertRobot\\": {\\n \\"RobotId\\": 123,\\n \\"RobotName\\": \\"robot名称\\",\\n \\"Type\\": \\"dingding\\",\\n \\"RobotAddress\\": \\"https://oapi.dingtalk.com/robot/send?access_token=e1a049121******\\",\\n \\"DailyNoc\\": true,\\n \\"DailyNocTime\\": \\"09:30,17:00\\",\\n \\"Token\\": \\"1656558719183be1245ab44********\\\\n\\",\\n \\"EnableOutgoing\\": true,\\n \\"CardTemplate\\": \\"{ \\\\\\"button\\\\\\": [ \\\\\\"claim\\\\\\", \\\\\\"close\\\\\\", \\\\\\"follow\\\\\\", \\\\\\"send_itsm\\\\\\", \\\\\\"block\\\\\\", \\\\\\"unResolvedIncident\\\\\\" ], \\\\\\"field\\\\\\": [ { \\\\\\"fieldName\\\\\\": \\\\\\"alarmName\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"notificationPolicy\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"alarmContent\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"alarmTime\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"seriesChart\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"includeEvent\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"assigned\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"similarAlarm\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"operator\\\\\\", \\\\\\"visible\\\\\\": true } ] }\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateOrUpdateIMRobot', + 'requestParamsDescription' => '### CardTemplate parameter description'."\n" + ."\n" + .'Sample template:'."\n" + ."\n" + .' {'."\n" + .' "field": ['."\n" + .' {'."\n" + .' "fieldName": "alarmName",'."\n" + .' "visible": false'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "notificationPolicy",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "alarmContent",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "alarmTime",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "seriesChart",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "includeEvent",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "assigned",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "similarAlarm",'."\n" + .' "visible": true'."\n" + .' },'."\n" + .' {'."\n" + .' "fieldName": "operator",'."\n" + .' "visible": true'."\n" + .' }'."\n" + .' ],'."\n" + .' "button": ['."\n" + .' "claim",'."\n" + .' "close",'."\n" + .' "block",'."\n" + .' "send_itsm",'."\n" + .' "unResolvedIncident",'."\n" + .' "follow"'."\n" + .' ]'."\n" + .' }'."\n" + ."\n" + .'* fieldName: the name of the field in the alert card. The following fields are included:'."\n" + ."\n" + .' * notificationPolicy: notification policy'."\n" + .' * alarmName: alert name'."\n" + .' * alarmContent: alert content'."\n" + .' * AlarmTime: the time when the alert is triggered'."\n" + .' * includeEvent: the number of events.'."\n" + .' * assigned: the users to which notifications are sent'."\n" + .' * operator: the user who handles the alert'."\n" + .' * similarAlarm: the last similar alert'."\n" + .' * seriesChart: the trend chart of the alert metrics'."\n" + ."\n" + .'* visible: specifies whether the content of the corresponding field on the alert card is visible.'."\n" + ."\n" + .' * true: visible'."\n" + .' * false: invisible'."\n" + ."\n" + .'* button: the setting button in the card. The parameter order corresponds to the card button order. The following buttons are available:'."\n" + ."\n" + .' * claim: claims alerts'."\n" + .' * close: clears alerts'."\n" + .' * follow: follows alerts'."\n" + .' * send_itsm: pushes alerts'."\n" + .' * block: blocks alerts'."\n" + .' * unResolvedIncident: unclears alerts'."\n", + 'changeSet' => [ + ['createdAt' => '2024-07-30T07:58:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-20T08:38:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-20T08:54:43.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-08T07:40:42.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateIMRobot'], + ], ], + ], + 'CreateOrUpdateNotificationPolicy' => [ + 'summary' => 'Creates or modifies a notification policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the notification policy.'."\n" + ."\n" + .'* If you do not specify this parameter, a new notification policy is created.'."\n" + .'* If you specify this parameter, the specified notification policy is modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'notificationpolicy_test'], + ], + [ + 'name' => 'MatchingRules', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The matching rules. Format:'."\n" + ."\n" + .' ['."\n" + .' {'."\n" + .' "matchingConditions": ['."\n" + .' { '."\n" + .' "value": "test", // The value of the matching condition. '."\n" + .' "key": "alertname", // The key of the matching condition. '."\n" + .' "operator": "eq" // The logical operator of the matching condition, including eq (equal to), neq (not equal to), in (contains), nin (does not contain), re (regular expression match), and nre (regular expression mismatch). '."\n" + .' }'."\n" + .' ]'."\n" + .' } '."\n" + .' ]'."\n", 'type' => 'string', 'required' => false, 'example' => '[ { "matchingConditions": [ { "value": "test", "key": "alertname", "operator": "eq" } ] } ]'], + ], + [ + 'name' => 'SendRecoverMessage', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether the status of an alert automatically changes to Resolved when all events related to the alert change to the Restored state. ARMS notifies contacts when the alert status changes to Resolved.'."\n" + ."\n" + .'* `true`: The system sends a notification.'."\n" + .'* `false`: The system does not send a notification.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'GroupRule', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'An array of alert event group objects.'."\n" + ."\n" + .'* If you do not specify the groupingFields field, all alerts will be sent to contacts based on `alertname`.'."\n" + .'* If you specify the groupingFields field, alerts with the same field will be sent to contacts in one notification.'."\n" + ."\n" + .'Sample statement:'."\n" + ."\n" + .' { '."\n" + .' "groupWait":5, // The waiting time for grouping. '."\n" + .' "groupInterval":30, // The time interval of grouping. '."\n" + .' "groupingFields":["alertname"] // The field that is used to group alert events. '."\n" + .' }'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "groupWait":5, "groupInterval":30, "groupingFields":["alertname"] }'], + ], + [ + 'name' => 'NotifyRule', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'An array of notification rule objects. Format:'."\n" + ."\n" + .' { '."\n" + .' "notifyStartTime":"00:00", // The start time of the notification window. '."\n" + .' "notifyEndTime":"23:59", // The end time of the notification window. '."\n" + .' "notifyChannels":["dingTalk", "email", "sms", "tts", "webhook"], // The notification methods. Valid values: dingTalk, email, sms, tts, and webhook. '."\n" + .' "notifyObjects":[{ // An array of notification objects. '."\n" + .' "notifyObjectType":"CONTACT", // The type of the notification object. Valid values: CONTACT (contact), CONTACT_GROUP (contact group), ARMS_CONTACT (ARMS contact), ARMS_CONTACT_GROUP (ARMS contact group), DING_ROBOT_GROUP (DingTalk, Lark, WeCom, or IM robot), and CONTACT_SCHEDULE (user on duty defined by a schedule). '."\n" + .' "notifyObjectId":123, // The ID of the notification object. '."\n" + .' "notifyObjectName":"test" // The name of the notification object. '."\n" + .' }]'."\n", 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "notifyStartTime": "00:00",'."\n" + .' "notifyEndTime": "23:59",'."\n" + .' "notifyChannels": ['."\n" + .' "dingTalk",'."\n" + .' "email",'."\n" + .' "sms",'."\n" + .' "tts",'."\n" + .' "webhook"'."\n" + .' ],'."\n" + .' "notifyObjects": ['."\n" + .' {'."\n" + .' "notifyObjectType": "CONTACT",'."\n" + .' "notifyObjectId": 123,'."\n" + .' "notifyObjectName": "test",'."\n" + .' "notifyChannels": ['."\n" + .' "email",'."\n" + .' "sms",'."\n" + .' "tts"'."\n" + .' ],'."\n" + .' '."\n" + .' }'."\n" + .' ]'."\n" + .'}'."\n"], + ], + [ + 'name' => 'NotifyTemplate', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The notification template. The default notification template is provided below the table.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "robotContent":"{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq "true" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}" }'], + ], + [ + 'name' => 'EscalationPolicyId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the escalation policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], + ], + [ + 'name' => 'Repeat', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to resend a notification for a long-lasting unresolved alert. Default value: true. Valid values:'."\n" + ."\n" + .'* `true`: If you set this parameter to `true`, you must set **RepeatInterval**.'."\n" + .'* `false`: If you set this parameter to `false`, you must set **EscalationPolicyId**.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'RepeatInterval', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '600'], + ], + [ + 'name' => 'IntegrationId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The integration ID of the ticket system to which alerts are pushed.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '34'], + ], + [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'name' => 'DirectedMode', + 'in' => 'formData', + 'schema' => ['title' => '极简模式', 'description' => 'Specifies whether to enable simple mode.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags that you want to add to the task.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 21, - ], + 'name' => 'State', + 'in' => 'formData', + 'schema' => ['title' => '通知策略是否启用，enable 启用，disable 停用', 'description' => 'Specifies whether to enable the notification policy. Valid values: enable and disable.', 'type' => 'string', 'required' => false, 'example' => 'enable'], ], ], 'responses' => [ 200 => [ - 'headers' => [], 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', - ], - 'RetcodeApps' => [ - 'description' => 'The list of applications monitored by Browser Monitoring.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'A1', - ], - 'RetcodeAppType' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* `web`: web application'."\n" - .'* `weex`: Weex mobile app'."\n" - .'* `mini_dd`: DingTalk mini program'."\n" - .'* `mini_alipay`: Alipay mini program'."\n" - .'* `mini_wx`: WeChat mini program'."\n" - .'* `mini_common`: mini program on other platforms'."\n", - 'type' => 'string', - 'example' => 'web', - ], - 'AppId' => [ - 'description' => 'The ID of the application. The parameter is an auto-increment parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16064', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], - 'NickName' => [ - 'description' => 'The alias of the application monitored by Browser Monitoring.'."\n", - 'type' => 'string', - 'example' => 'B1', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'NotificationPolicy' => [ + 'title' => '', + 'description' => 'An array of notification policy objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => 'notificationpolicy_test'], + 'MatchingRules' => [ + 'title' => '', + 'description' => 'The matching rules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'description' => 'The matching conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The key of the matching condition.'."\n", 'type' => 'string', 'example' => 'altertname'], + 'Value' => ['title' => '', 'description' => 'The value of the matching condition.'."\n", 'type' => 'string', 'example' => 'test'], + 'Operator' => ['title' => '', 'description' => 'The logical operator of the matching condition. Valid values:'."\n" + ."\n" + .'* `eq`: equal to'."\n" + .'* `neq`: not equal to'."\n" + .'* `in`: contains'."\n" + .'* `nin`: does not contain'."\n" + .'* `re`: regular expression match'."\n" + .'* `nre`: regular expression mismatch'."\n", 'type' => 'string', 'example' => 'eq'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', + 'example' => '', + ], + 'SendRecoverMessage' => ['title' => '', 'description' => 'Indicates whether the status of an alert automatically changes to Resolved when all events related to the alert change to the Restored state. ARMS notifies contacts when the alert status changes to Resolved.'."\n" + ."\n" + .'* `true`: The system sends a notification.'."\n" + .'* `false`: The system does not send a notification.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'GroupRule' => [ + 'title' => '', + 'description' => 'An array of alert event group objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'GroupingFields' => [ + 'title' => '', + 'description' => 'An array of alert event group objects.'."\n" + ."\n" + .'* If you do not specify the groupingFields field, all alerts will be sent to contacts based on `alertname`.'."\n" + .'* If you specify the groupingFields field, alerts with the same field will be sent to contacts in one notification.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The field that is used for grouping.'."\n", 'type' => 'string', 'example' => '["alertName","clustname"]', 'title' => ''], + 'example' => '', + ], + 'GroupWait' => ['title' => '', 'description' => 'The waiting time for grouping. Unit: seconds. Default value: 5.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'GroupInterval' => ['title' => '', 'description' => 'The time interval of grouping. Unit: seconds. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30'], ], - 'Tags' => [ - 'description' => 'The tags of the task.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', + 'example' => '', + ], + 'NotifyRule' => [ + 'title' => '', + 'description' => 'An array of notification rule objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'NotifyStartTime' => ['title' => '', 'description' => 'The start time of the notification window.'."\n", 'type' => 'string', 'example' => '00:00'], + 'NotifyEndTime' => ['title' => '', 'description' => 'The end time of the notification window.'."\n", 'type' => 'string', 'example' => '23:59'], + 'NotifyChannels' => [ + 'title' => '', + 'description' => 'The notification method.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The notification methods. Valid values:'."\n" + ."\n" + .'* `dingTalk`: DingTalk'."\n" + .'* `email`: email'."\n" + .'* `sms`: text message'."\n" + .'* `tts`: phone call'."\n" + .'* `webhook`: webhook'."\n", 'type' => 'string', 'example' => '["dingTalk", "email", "sms", "tts", "webhook"]', 'title' => ''], + 'example' => '', + ], + 'NotifyObjects' => [ + 'title' => '', + 'description' => 'An array of notification objects.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the notification object.'."\n", + 'type' => 'object', + 'properties' => [ + 'NotifyObjectType' => ['title' => '', 'description' => 'The type of the notification object. Valid values:'."\n" + ."\n" + .'* CONTACT: contact'."\n" + .'* CONTACT_GROUP: contact group'."\n" + .'* ARMS_CONTACT: ARMS contact'."\n" + .'* ARMS_CONTACT_GROUP: ARMS contact group'."\n" + .'* DING_ROBOT_GROUP: DingTalk, Lark, WeCom, or IM robot'."\n" + .'* CONTACT_SCHEDULE: user on duty defined by a schedule'."\n", 'type' => 'string', 'example' => 'CONTACT'], + 'NotifyObjectId' => ['title' => '', 'description' => 'The ID of the notification object.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'NotifyObjectName' => ['title' => '', 'description' => 'The name of the notification object.'."\n", 'type' => 'string', 'example' => 'test'], + 'NotifyChannels' => [ + 'title' => '通知对象为联系人时的联系方式', + 'description' => 'The notification methods specified for a contact.', + 'type' => 'array', + 'items' => ['title' => '', 'description' => 'The notification methods. Valid values:'."\n" + ."\n" + .'- email: email'."\n" + .'- sms: text message'."\n" + .'- tts: phone call', 'type' => 'string', 'example' => 'sms'], + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'example' => '', ], ], + 'example' => '', ], - 'description' => '', + 'NotifyTemplate' => [ + 'title' => '', + 'description' => 'The notification template.'."\n", + 'type' => 'object', + 'properties' => [ + 'EmailTitle' => ['title' => '', 'description' => 'The title of the alert notification sent through email.'."\n", 'type' => 'string', 'example' => '{{ .commonLabels.alertname }}'], + 'EmailContent' => ['title' => '', 'description' => 'The content of the alert notification sent through email.'."\n", 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href="{{.generatorURL}}" > 详情链接</a> {{ end }} {{ end }}'], + 'EmailRecoverTitle' => ['title' => '', 'description' => 'The title of the alert resolution notification sent through email.'."\n", 'type' => 'string', 'example' => '{{ .commonLabels.alertname }}'], + 'EmailRecoverContent' => ['title' => '', 'description' => 'The content of the alert resolution notification sent through email.'."\n", 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href="{{.generatorURL}}" > 详情链接</a> {{ end }} {{ end }}'], + 'SmsContent' => ['title' => '', 'description' => 'The content of the alert notification sent through text message.'."\n", 'type' => 'string', 'example' => '发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'SmsRecoverContent' => ['title' => '', 'description' => 'The content of the alert resolution notification sent through text message.'."\n", 'type' => 'string', 'example' => '告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'TtsContent' => ['title' => '', 'description' => 'The content of the alert notification by phone.'."\n", 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'TtsRecoverContent' => ['title' => '', 'description' => 'The content of the alert resolution notification by phone.'."\n", 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'RobotContent' => ['title' => '', 'description' => 'The content of the alert notification sent by the IM robot.'."\n", 'type' => 'string', 'example' => '{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq "true" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}'], + ], + 'example' => '', + ], + 'EscalationPolicyId' => ['title' => '', 'description' => 'The ID of the escalation policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Repeat' => ['title' => '', 'description' => 'Indicates whether a notification is resent for a long-lasting unresolved alert. Default value: true. Valid values:'."\n" + ."\n" + .'* `true`: The system resends a notification for a long-lasting unresolved alert at a specified time interval.'."\n" + .'* `false`: The system sends a notification for a long-lasting unresolved alert based on an escalation policy.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RepeatInterval' => ['title' => '', 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '600'], + 'IntegrationId' => ['title' => '', 'description' => 'The integration ID of the ticket system to which alerts are pushed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34'], + 'DirectedMode' => ['title' => '极简模式', 'description' => 'Specifies whether to enable simple mode.', 'type' => 'boolean', 'example' => 'false'], + 'State' => ['title' => '通知策略是否启用，enable 启用，disable 停用', 'description' => 'Indicates whether the notification policy is enabled. Valid values: enable and disable.', 'type' => 'string', 'example' => 'enable'], ], + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99A663CB-8D7B-4B0D-A006-03C8EE38E7BB\\",\\n \\"RetcodeApps\\": [\\n {\\n \\"AppName\\": \\"A1\\",\\n \\"RetcodeAppType\\": \\"web\\",\\n \\"AppId\\": 16064,\\n \\"Pid\\": \\"atc889zkcf@d8deedfa9bf****\\",\\n \\"NickName\\": \\"B1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRetcodeAppsResponse>\\n<RequestId>99A663CB-8D7B-4B0D-A006-03C8EE38E7BB</RequestId>\\n<RetcodeApps>\\n <RetcodeAppType>web</RetcodeAppType>\\n <AppId>16064</AppId>\\n <Pid>atc889zkcf@d8deedfa9bf****</Pid>\\n <AppName>A1</AppName>\\n</RetcodeApps>\\n</ListRetcodeAppsResponse>","errorExample":""}]', - 'title' => 'ListRetcodeApps', - 'description' => '****', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchRetcodeAppByPage' => [ - 'summary' => 'Queries Browser Monitoring tasks by page.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"NotificationPolicy\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"notificationpolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"SendRecoverMessage\\": true,\\n \\"GroupRule\\": {\\n \\"GroupingFields\\": [\\n \\"[\\\\\\"alertName\\\\\\",\\\\\\"clustname\\\\\\"]\\"\\n ],\\n \\"GroupWait\\": 5,\\n \\"GroupInterval\\": 30\\n },\\n \\"NotifyRule\\": {\\n \\"NotifyStartTime\\": \\"00:00\\",\\n \\"NotifyEndTime\\": \\"23:59\\",\\n \\"NotifyChannels\\": [\\n \\"[\\\\\\"dingTalk\\\\\\", \\\\\\"email\\\\\\", \\\\\\"sms\\\\\\", \\\\\\"tts\\\\\\", \\\\\\"webhook\\\\\\"]\\"\\n ],\\n \\"NotifyObjects\\": [\\n {\\n \\"NotifyObjectType\\": \\"CONTACT\\",\\n \\"NotifyObjectId\\": 123,\\n \\"NotifyObjectName\\": \\"test\\",\\n \\"NotifyChannels\\": [\\n \\"sms\\"\\n ]\\n }\\n ]\\n },\\n \\"NotifyTemplate\\": {\\n \\"EmailTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"EmailRecoverTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"SmsContent\\": \\"发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"SmsRecoverContent\\": \\"告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"RobotContent\\": \\"{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq \\\\\\"true\\\\\\" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}\\"\\n },\\n \\"EscalationPolicyId\\": 123,\\n \\"Repeat\\": true,\\n \\"RepeatInterval\\": 600,\\n \\"IntegrationId\\": 34,\\n \\"DirectedMode\\": false,\\n \\"State\\": \\"enable\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateOrUpdateNotificationPolicy', + 'requestParamsDescription' => '### Default notification template specified by the NotifyTemplate field'."\n" + ."\n" + .' {'."\n" + .' // An alert notification sent through email'."\n" + .' "emailTitle":"{{ .commonLabels.alertname }}",'."\n" + ."\n" + .' "emailContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} <a href="{{.generatorURL}}" >Link</a> {{ end }} {{ end }}",'."\n" + ."\n" + .' // An alert resolution notification sent through email'."\n" + .' "emailRecoverTitle":"{{ .commonLabels.alertname }}",'."\n" + ."\n" + .' "emailRecoverContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} <a href="{{.generatorURL}}" >Link</a> {{ end }} {{ end }}",'."\n" + ."\n" + .' // An alert notification sent through text message'."\n" + .' "smsContent":"Notification on the occurrence of a {{ .level }} alert. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}}}",'."\n" + ."\n" + .' // An alert resolution notification sent through text message'."\n" + .' "smsRecoverContent":"Alert resolution notification. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}",'."\n" + ."\n" + .' // An alert notification by phone'."\n" + .' "tsContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}",'."\n" + ."\n" + .' // An alert resolution notification by phone'."\n" + .' "ttsRecoverContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}",'."\n" + ."\n" + .' // An alert notification sent by the instant message (IM) robot'."\n" + .' "robotContent":"{{if .commonLabels.clustername }} > Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} > Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{.annotations.message}} {{if .generatorURL }} [Link]({{.generatorURL}}) {{ end }} {{if eq "true" .labels._aliyun_arms_is_denoise_filtered }} (Suspected noise) {{end}} {{end}}"'."\n" + ."\n" + .' }'."\n", + 'changeSet' => [ + ['createdAt' => '2024-06-19T03:07:27.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-17T11:53:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-30T06:16:01.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-20T13:42:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateNotificationPolicy'], + ], ], + 'ramActions' => [], + ], + 'CreateOrUpdateSilencePolicy' => [ + 'summary' => 'Creates or modifies a silence policy.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7092,262 +4565,166 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RetcodeAppName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'App1', - ], + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the silence policy.'."\n" + ."\n" + .'* If you do not configure this parameter, a new silence policy is created.'."\n" + .'* If you configure this parameter, the specified silence policy is modified.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1234'], ], [ - 'name' => 'PageNumber', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '1', - ], + 'name' => 'Name', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the silence policy.'."\n", 'type' => 'string', 'required' => true, 'example' => 'silencepolicy_test'], ], [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'example' => '5', - ], + 'name' => 'MatchingRules', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The matching rules. The following code shows the format of matching rules:'."\n" + ."\n" + .' ['."\n" + .' {'."\n" + .' "matchingConditions": ['."\n" + .' {'."\n" + .' "value": "test", // The value of the matching condition. '."\n" + .' "key": "altertname", // The key of the matching condition. '."\n" + .' "operator": "eq" // The logical operator of the matching condition, including eq (equal to), neq (not equal to), in (contains), nin (does not contain), re (regular expression match), and nre (regular expression mismatch). '."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n", 'type' => 'string', 'required' => false, 'example' => '[ { "matchingConditions": [ { "value": "test", "key": "altertname", "operator": "eq" } ] } ]'], ], [ 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'State', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable the silence policy. Valid values: enable and disable.', 'type' => 'string', 'required' => false, 'example' => 'enable'], + ], + [ + 'name' => 'EffectiveTimeType', 'in' => 'query', + 'allowEmptyValue' => false, 'schema' => [ - 'description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", + 'description' => 'The effective duration of the silence policy. Valid values: PERMANENT, CUSTOM_TIME, and CYCLE_EFFECT.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'rg-acfmxyexli2****', + 'example' => 'PERMANENT', + 'default' => 'PERMANENT', + 'enum' => ['PERMANENT', 'CYCLE_EFFECT', 'CUSTOM_TIME'], + 'title' => '', ], ], [ - 'name' => 'RetcodeAppId', + 'name' => 'TimePeriod', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The application ID.'."\n" - ."\n" - .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the browser address bar contains the pid of this application in the format of `pid=xxx`. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is `xxx%4074xxx`, you must replace **%40** with the at sign (@). The actual PID is `xxx@74xxx`.'."\n", + 'description' => 'The recurring period. This parameter is required when EffectiveTimeType is set to CYCLE_EFFECT. DAY: The silence policy is effective by day. WEEK: The silence policy is effective by week.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'eb4zdose6v@9781be0f44d****', + 'example' => 'DAY', + 'enum' => ['DAY', 'WEEK'], + 'title' => '', ], ], [ - 'name' => 'Tags', + 'name' => 'TimeSlots', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - 'description' => '', - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The time period during which the silence policy is effective. If you set EffectiveTimeType to CUSTOM_TIME, specify a custom time period in the following format: \\[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}] If you set EffectiveTimeType to CYCLE_EFFECT and TimePeriod to DAY, specify a custom time period in the following format: \\[{"startTime":"22:13","endTime":"22:21"}]. The start time cannot be later than the end time. If you set EffectiveTimeType to CYCLE_EFFECT and TimePeriod to WEEK, specify a custom time period in the following format: \\[{"startWeek":"1", "endWeek":"2" "startTime":"22:13","endTime":"22:21"}]. Valid values of startWeek and endWeek: 1 to 7. The start time cannot be later than the end time.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797A64E', - ], - 'PageBean' => [ - 'description' => 'The returned page information.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'SilencePolicy' => [ + 'title' => '', + 'description' => 'The silence policy.'."\n", 'type' => 'object', 'properties' => [ - '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' => '2', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '8', - ], - 'RetcodeApps' => [ - 'description' => 'The browser monitoring tasks that are returned.'."\n", + 'Id' => ['title' => '', 'description' => 'The ID of the silence policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The name of the silence policy.'."\n", 'type' => 'string', 'example' => 'silencepolicy_test'], + 'MatchingRules' => [ + 'title' => '', + 'description' => 'A list of matching rules.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The matching rule.'."\n", 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'* `TRACE`: Application Monitoring'."\n" - .'* `RETCODE`: Browser Monitoring'."\n", - 'type' => 'string', - 'example' => 'RETCODE', - ], - 'AppName' => [ - 'description' => 'The name of the application.'."\n", - 'type' => 'string', - 'example' => 'a3', - ], - 'RetcodeAppType' => [ - 'description' => 'The type of the application. Valid values:'."\n" - ."\n" - .'* `web`: web application'."\n" - .'* `weex`: Weex mobile app'."\n" - .'* `mini_dd`: DingTalk mini program'."\n" - .'* `mini_alipay`: Alipay mini program'."\n" - .'* `mini_wx`: WeChat mini program'."\n" - .'* `mini_common`: mini program on other platforms'."\n", - 'type' => 'string', - 'example' => 'web', - ], - 'UpdateTime' => [ - 'description' => 'The time when the task was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1545363321000', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1545363321000', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'eb4zdose6v@9781be0f44d****', - ], - 'AppId' => [ - 'description' => 'The ID of the application. The parameter is an auto-increment parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16064', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '12341234', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'NickName' => [ - 'description' => 'The alias of the application.'."\n", - 'type' => 'string', - 'example' => 'c1', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], - 'Tags' => [ - 'description' => 'The tag.'."\n", + 'MatchingConditions' => [ + 'title' => '', + 'description' => 'A list of matching conditions.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The matching condition.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'TestValue', - ], + 'Key' => ['title' => '', 'description' => 'The key of the matching condition.'."\n", 'type' => 'string', 'example' => 'altertname'], + 'Value' => ['title' => '', 'description' => 'The value of the matching condition.'."\n", 'type' => 'string', 'example' => 'test'], + 'Operator' => ['title' => '', 'description' => 'The logical operator of the matching condition. Valid values:'."\n" + ."\n" + .'* `eq`: equal to'."\n" + .'* `neq`: not equal to'."\n" + .'* `in`: contains'."\n" + .'* `nin`: does not contain'."\n" + .'* `re`: regular expression match'."\n" + .'* `nre`: regular expression mismatch'."\n", 'type' => 'string', 'example' => 'eq'], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'State' => ['title' => '', 'description' => 'Specifies whether to enable the silence policy. Valid values: enable and disable.', 'type' => 'string', 'example' => 'enable'], + 'EffectiveTimeType' => ['description' => 'The effective type. Valid values: PERMANENT: The policy is effective permanently. CYCLE_EFFECT: The policy is effective cyclically. CUSTOM_TIME: The policy is effective during a custom time period.'."\n", 'type' => 'string', 'example' => 'PERMANENT', 'title' => ''], + 'TimePeriod' => ['description' => 'Effective period. Valid values: DAY: daily WEEK: weekly'."\n", 'type' => 'string', 'example' => 'WEEK', 'title' => ''], + 'TimeSlots' => ['description' => 'The time period during which the silence policy is effective.'."\n", 'type' => 'string', 'example' => '[{startWeek: "1", startTime: "00:00", endTime: "11:59", endWeek:"7"}]'."\n", 'title' => ''], ], + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797A64E\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 8,\\n \\"RetcodeApps\\": [\\n {\\n \\"Type\\": \\"RETCODE\\",\\n \\"AppName\\": \\"a3\\",\\n \\"RetcodeAppType\\": \\"web\\",\\n \\"UpdateTime\\": 1545363321000,\\n \\"CreateTime\\": 1545363321000,\\n \\"Pid\\": \\"eb4zdose6v@9781be0f44d****\\",\\n \\"AppId\\": 16064,\\n \\"UserId\\": \\"12341234\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"NickName\\": \\"c1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchRetcodeAppByPageResponse>\\n<PageBean>\\n <TotalCount>8</TotalCount>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <RetcodeApps>\\n <Type>RETCODE</Type>\\n <AppId>16064</AppId>\\n <UserId>12341234</UserId>\\n <CreateTime>1545363321000</CreateTime>\\n <UpdateTime>1545363321000</UpdateTime>\\n <Pid>aokcdqn3ly@741623b4e91****</Pid>\\n <RegionId>cn-hangzhou</RegionId>\\n <AppName>a3</AppName>\\n </RetcodeApps>\\n</PageBean>\\n<RequestId>626037F5-FDEB-45B0-804C-B3C92797A64E</RequestId>\\n</SearchRetcodeAppByPageResponse>","errorExample":""}]', - 'title' => 'SearchRetcodeAppByPage', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetRetcodeLogstore' => [ - 'summary' => 'Queries the Log Service project and Logstore that correspond to an application of browser monitoring.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"SilencePolicy\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"silencepolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"State\\": \\"enable\\",\\n \\"EffectiveTimeType\\": \\"PERMANENT\\",\\n \\"TimePeriod\\": \\"WEEK\\",\\n \\"TimeSlots\\": \\"[{startWeek: \\\\\\"1\\\\\\", startTime: \\\\\\"00:00\\\\\\", endTime: \\\\\\"11:59\\\\\\", endWeek:\\\\\\"7\\\\\\"}]\\\\n\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateSilencePolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <SilencePolicy>\\n <Id>1234</Id>\\n <Name>silencepolicy_test</Name>\\n <MatchingRules>\\n <MatchingConditions>\\n <Key>altertname</Key>\\n <Value>test</Value>\\n <Operator>eq</Operator>\\n </MatchingConditions>\\n </MatchingRules>\\n </SilencePolicy>\\n</CreateOrUpdateSilencePolicyResponse>","errorExample":""}]', + 'title' => 'CreateOrUpdateSilencePolicy', + 'changeSet' => [ + ['createdAt' => '2024-08-12T01:35:11.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-05-24T03:41:59.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-05-24T01:43:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-20T13:42:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateSilencePolicy'], + ], ], + 'ramActions' => [], + ], + 'CreateOrUpdateWebhookContact' => [ + 'summary' => 'Creates or modifies a webhook alert contact.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7355,29 +4732,53 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Pid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application. To obtain the PID of the application, perform the following steps: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of the application. The URL in the address bar contains the PID of the application. The PID is in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with the at sign (@) to obtain xxx@74xxx.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], + 'name' => 'WebhookId', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The ID of the webhook alert contact.'."\n" + ."\n" + .'* If you do not specify this parameter, a new webhook alert contact is created.'."\n" + .'* If you specify this parameter, the specified webhook alert contact is modified.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '123'], ], [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'WebhookName', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The name of the webhook alert contact.'."\n", 'type' => 'string', 'required' => true, 'example' => 'Webhook告警'], + ], + [ + 'name' => 'Method', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The HTTP request method.'."\n" + ."\n" + .'* Post'."\n" + .'* Get'."\n", 'type' => 'string', 'required' => true, 'example' => 'Post'], + ], + [ + 'name' => 'Url', + 'in' => 'formData', + 'schema' => ['title' => 'Url', 'description' => 'The URL of the HTTP request **method**.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******'], + ], + [ + 'name' => 'BizHeaders', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The HTTP request headers.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"Content-Type":"application/json;charset=utf-8"}]'], + ], + [ + 'name' => 'BizParams', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The parameters in the HTTP request.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{"content":"mike"}]'], + ], + [ + 'name' => 'Body', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The notification template that is sent when an alert is triggered. This parameter is required if the **Method** parameter is set to **Post**. You can use the `$content` placeholder to specify the notification content. The content cannot exceed 500 characters in length. For more information, see [Variable description of a notification template](~~251834~~).\\\\'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "告警时间":"{{ .startTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'], + ], + [ + 'name' => 'RecoverBody', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The notification template that is sent when an alert is resolved. This parameter is required if the **Method** parameter is set to **Post**. You can use the `$content` placeholder to specify the notification content. The content cannot exceed 500 characters in length. For more information, see [Variable description of a notification template](~~251834~~).'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "恢复时间":"{{ .endTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'], ], ], 'responses' => [ @@ -7387,66 +4788,56 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****'], + 'WebhookContact' => [ + 'description' => 'The returned webhook alert contact.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'The status of the request.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The content of the log.'."\n", - 'type' => 'string', - 'example' => 'retcode app or task can not be found!', - ], - 'RetcodeSLSConfig' => [ - 'description' => 'The information about Log Service.'."\n", + 'WebhookId' => ['title' => '', 'description' => 'The ID of the webhook alert contact.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'WebhookName' => ['title' => '', 'description' => 'The name of the webhook alert contact.'."\n", 'type' => 'string', 'example' => 'Webhook告警'], + 'Webhook' => [ + 'description' => 'The information about the webhook alert contact.'."\n", 'type' => 'object', 'properties' => [ - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Project' => [ - 'description' => 'The Log Service project.'."\n", - 'type' => 'string', - 'example' => 'test-project', - ], - 'Logstore' => [ - 'description' => 'The Log Service Logstore.'."\n", - 'type' => 'string', - 'example' => 'log-test-220431', - ], + 'Method' => ['title' => '', 'description' => 'The HTTP request method.'."\n" + ."\n" + .'* Post'."\n" + .'* Get'."\n", 'type' => 'string', 'example' => 'Post'], + 'Url' => ['title' => 'url', 'description' => 'The URL of the request method.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******'], + 'BizHeaders' => ['title' => '', 'description' => 'The HTTP request headers.'."\n", 'type' => 'string', 'example' => '[{"Content-Type":"application/json;charset=utf-8"}]'], + 'BizParams' => ['title' => '', 'description' => 'The parameters in the HTTP request.'."\n", 'type' => 'string', 'example' => '[{"content":"mike"}]'], + 'Body' => ['title' => '', 'description' => 'The alert notification template.'."\n", 'type' => 'string', 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "告警时间":"{{ .startTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'], + 'RecoverBody' => ['title' => '', 'description' => 'The notification template for clearing alerts.'."\n", 'type' => 'string', 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "恢复时间":"{{ .endTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"Message\\": \\"retcode app or task can not be found!\\",\\n \\"RetcodeSLSConfig\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Project\\": \\"test-project\\",\\n \\"Logstore\\": \\"log-test-220431\\"\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetRetcodeLogstore', - ], - 'GetRetcodeDataByQuery' => [ - 'summary' => 'Queries the Browser Monitoring data based on a query statement of Log Service.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"WebhookContact\\": {\\n \\"WebhookId\\": 123,\\n \\"WebhookName\\": \\"Webhook告警\\",\\n \\"Webhook\\": {\\n \\"Method\\": \\"Post\\",\\n \\"Url\\": \\"https://oapi.dingtalk.com/robot/send?access_token=e1a049121******\\",\\n \\"BizHeaders\\": \\"[{\\\\\\"Content-Type\\\\\\":\\\\\\"application/json;charset=utf-8\\\\\\"}]\\",\\n \\"BizParams\\": \\"[{\\\\\\"content\\\\\\":\\\\\\"mike\\\\\\"}]\\",\\n \\"Body\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"告警时间\\\\\\":\\\\\\"{{ .startTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\",\\n \\"RecoverBody\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"恢复时间\\\\\\":\\\\\\"{{ .endTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreateOrUpdateWebhookContact', + 'changeSet' => [ + ['createdAt' => '2022-01-07T10:38:36.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateWebhookContact'], + ], ], + 'ramActions' => [], + ], + 'CreatePrometheusAlertRule' => [ + 'summary' => 'Creates an alert rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7454,272 +4845,188 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n" - ."\n" - .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Query', + 'name' => 'AlertName', 'in' => 'query', - 'schema' => [ - 'description' => 'The query statement that conforms to the query syntax of a Log Service Logstore.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 't : pv|select sum(times) as pv , approx_distinct(uid) as uv , (date-date%3600000) as date group by date', - ], + 'schema' => ['description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prometheus_Alert', 'title' => ''], ], [ - 'name' => 'From', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1668687302', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], ], [ - 'name' => 'To', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1668688000', - ], + 'schema' => ['description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'- 99: custom alert'."\n" + .'- 101: Prometheus Service alert', 'type' => 'string', 'required' => false, 'example' => '101', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'NotifyType', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The method that is used to send alert notifications. Valid values:'."\n" + ."\n" + .'- `ALERT_MANAGER`: Alert notifications are sent by Operation Center. This is the default value.'."\n" + .'- `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.', 'type' => 'string', 'required' => false, 'example' => 'ALERT_MANAGER', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* 2XX: The request was successful.'."\n" - .'* 3XX: A redirection message was returned.'."\n" - .'* 4XX: The request was invalid.'."\n" - .'* 5XX: A server error occurred.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the call fails.'."\n", - 'type' => 'string', - 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The Browser Monitoring data returned.'."\n", - 'type' => 'string', - 'example' => '{"total":0,"auth":false,"pageSize":20,"completed":true,"page":1,"items":[]}', - ], - ], - ], + [ + 'name' => 'DispatchRuleId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the notification policy. This parameter is required if the NotifyType parameter is set to `DISPATCH_RULE`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10282', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"-\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{\\\\n \\\\\\"total\\\\\\": 1,\\\\n \\\\\\"auth\\\\\\": false,\\\\n \\\\\\"pageSize\\\\\\": 20,\\\\n \\\\\\"completed\\\\\\": true,\\\\n \\\\\\"page\\\\\\": 1,\\\\n \\\\\\"items\\\\\\": [\\\\n {\\\\n \\\\\\"date\\\\\\": \\\\\\"1701820800000\\\\\\",\\\\n \\\\\\"__time__\\\\\\": 1701410567,\\\\n \\\\\\"uv\\\\\\": \\\\\\"64\\\\\\",\\\\n \\\\\\"__source__\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"pv\\\\\\": \\\\\\"890\\\\\\"\\\\n }\\\\n ]\\\\n\\\\t}\\"\\n}","type":"json"}]', - 'title' => 'GetRetcodeDataByQuery', - ], - 'GetRetcodeAppByPid' => [ - 'summary' => 'Queries the objects of a Browser Monitoring application by process identifier (PID).', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Expression', + 'in' => 'query', + 'schema' => ['description' => 'The expression of the alert rule. The expression must follow the PromQL syntax.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'Duration', 'in' => 'query', - 'schema' => [ - 'description' => 'The PID of the application. To obtain the PID of the application, perform the following steps: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of the application. The URL in the address bar contains the PID of the application. The PID is in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with the at sign (@) to obtain xxx@74xxx.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b590lhguqs@9781be0f44dXXXX', - ], + 'schema' => ['description' => 'The duration. The value ranges from 1 to 1440 minutes.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '10m', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Message', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The content of the alert notification. Tags can be referenced in the {{$labels.xxx}} format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => ['description' => 'The tags that are described in a JSON string. You must specify the name and value of each tag.', 'type' => 'string', 'required' => false, 'example' => '[{"Value": "critical","Name": "severity"}]', 'title' => ''], + ], + [ + 'name' => 'Annotations', + 'in' => 'query', + 'schema' => ['description' => 'The annotations that are described in a JSON string. You must specify the name and value of each annotation.', 'type' => 'string', 'required' => false, 'example' => '[{"Value": "xxx","Name": "description"}]', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ + 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The tag key.'."\n", - 'example' => 'TestKey', - ], - 'Value' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The tag value.'."\n", - 'example' => 'TestValue', - ], + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 21, - 'description' => 'The list of tags.'."\n", + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', - ], - 'RetcodeApp' => [ - 'description' => 'The returned application data.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', 'title' => ''], + 'PrometheusAlertRule' => [ + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'AppName' => [ - 'description' => 'The name of the application that is monitored by Browser Monitoring.'."\n", - 'type' => 'string', - 'example' => 'testRetcodeAppXXXX', - ], - 'RetcodeAppType' => [ - 'description' => 'The type of the application that is monitored by Browser Monitoring. Valid values:'."\n" - ."\n" - .'* `web`: web application'."\n" - .'* `weex`: Weex mobile app'."\n" - .'* `mini_dd`: DingTalk mini program'."\n" - .'* `mini_alipay`: Alipay mini program'."\n" - .'* `mini_wx`: WeChat mini program'."\n" - .'* `mini_common`: mini program on other platforms'."\n", - 'type' => 'string', - 'example' => 'web', - ], - 'AppId' => [ - 'description' => 'The ID of the application. The parameter is an auto-increment parameter.'."\n", - 'type' => 'string', - 'example' => '2787XXXX', - ], - 'Pid' => [ - 'description' => 'The process identifier (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'b590lhguqs@9781be0f44dXXXX', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxidtzXXXX', + 'Status' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- `1`: The alert rule is enabled.'."\n" + .'- `0`: The alert rule is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The type of the alert rule.', 'type' => 'string', 'example' => 'Kubernetes组件告警', 'title' => ''], + 'NotifyType' => ['description' => 'The method that is used to send alert notifications. Valid values:'."\n" + ."\n" + .'- ALERT_MANAGER: Alert notifications are sent by Operation Center.'."\n" + .'- DISPATCH_RULE: Alert notifications are sent based on the specified notification policy.', 'type' => 'string', 'example' => 'ALERT_MANAGER', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.', 'type' => 'string', 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', 'title' => ''], + 'Message' => ['description' => 'The content of the alert notification. Tags can be referenced in the {{$labels.xxx}} format.', 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + 'Duration' => ['description' => 'The duration. The value ranges from 1 to 1440 minutes.'."\n", 'type' => 'string', 'example' => '10m', 'title' => ''], + 'DispatchRuleId' => ['description' => 'The ID of the notification policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '10282', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'Prometheus_Alert', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '3888704', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags of the alert rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the tag.'."\n", 'type' => 'string', 'example' => 'severity', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'critical', 'title' => ''], + ], + 'description' => 'The tags of the alert rule.'."\n", + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Tags' => [ - 'description' => 'The tags that are attached to the instance.'."\n", + 'Annotations' => [ + 'description' => 'The annotations of the alert rule.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The annotation of the alert rule.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'testKey', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'testValue', - ], + 'Name' => ['description' => 'The name of the annotation.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Value' => ['description' => 'The value of the annotation.'."\n", 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"RetcodeApp\\": {\\n \\"AppName\\": \\"testRetcodeAppXXXX\\",\\n \\"RetcodeAppType\\": \\"web\\",\\n \\"AppId\\": \\"2787XXXX\\",\\n \\"Pid\\": \\"b590lhguqs@9781be0f44dXXXX\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxidtzXXXX\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetRetcodeAppByPid', - ], - 'UpdateRumFileStatus' => [ - 'summary' => 'Updates the status of a Real User Monitoring (RUM) file. You can call this operation after the RUM file is uploaded.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRule\\": {\\n \\"Status\\": 1,\\n \\"Type\\": \\"Kubernetes组件告警\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"10m\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'CreatePrometheusAlertRule', + 'description' => '> 建议使用[CreateOrUpdateAlertRule](~~411960~~)接口创建Prometheus告警规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-31T01:50:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-11T12:16:04.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusAlertRule'], + ], ], + ], + 'CreatePrometheusInstance' => [ + 'summary' => 'Creates a Managed Service for Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -7728,336 +5035,512 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'create', + 'abilityTreeCode' => '165691', + 'abilityTreeNodes' => ['FEATUREarmsFRX7PL'], ], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'atc8xxxx'."\n" - .'cf@d8deedfa9bf****', - ], + 'schema' => ['title' => '', 'description' => 'The actual region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shanghai'], ], [ - 'name' => 'VersionId', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], + 'schema' => ['title' => '', 'description' => 'The instance type. Valid values: '."\n" + .'- remote-write: Prometheus for Remote Write.'."\n" + .'- ecs (no longer supported): Prometheus for ECS.'."\n" + .'- global-view: Prometheus for GlobalView.'."\n" + .'- aliyun-cs (no longer supported): Prometheus for Container Service.'."\n" + .'- cloud-product (no longer supported): Prometheus for Cloud Service.'."\n" + .'- cloud-monitor (no longer supported): Prometheus for Hybrid Cloud Monitoring.'."\n" + .'- flink (no longer supported): Prometheus for Flink.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'remote-write'], ], [ - 'name' => 'Uuid', + 'name' => 'VpcId', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique ID of the file. If you do not set this parameter, the system automatically sets a UUID for you.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'MS4wLjAtbWFpbi4wZjM0NzRlOSxxxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The VPC ID. This parameter is required when ClusterType is set to ecs or aliyun-cs for a managed ASK cluster.', 'type' => 'string', 'required' => false, 'example' => 'vpc-rpn**********'], ], [ - 'name' => 'FileName', + 'name' => 'VSwitchId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test.js.map', - ], + 'schema' => ['title' => '', 'description' => 'The vSwitch ID. This parameter is required when ClusterType is set to ecs or aliyun-cs for a managed ASK cluster.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'vsw-bp1*********'], ], [ - 'name' => 'Size', + 'name' => 'SecurityGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The size of the file. Unit: bytes.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['title' => '', 'description' => 'The Network Security group ID. This parameter is required when ClusterType is set to ecs or aliyun-cs for a managed ASK cluster.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'sg-bp1********'], ], [ - 'name' => 'Status', + 'name' => 'ClusterId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The Container Service cluster ID. This parameter is required when ClusterType is set to aliyun-cs.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the cluster to create. This parameter is required when ClusterType is set to remote-write, ecs, or global-view.'."\n" + ."\n" + .'For ecs instances, the ClusterName must follow the format "name-vpc-id", and the name part cannot exceed 24 characters. Example: "mytest1-vpc-xxxxxxxxxxx".', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'clusterNameOfTest'], + ], + [ + 'name' => 'SubClustersJson', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The JSON string of sub-instances for the GlobalView instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '当clusterType为global-view时，需要传此参数：需要聚合的集群的信息列表；示例：'."\n" + .'['."\n" + .' {'."\n" + .' "headers":{'."\n" + ."\n" + .' },'."\n" + .' "regionId":"cn-hangzhou",'."\n" + .' "sourceType":"AlibabaPrometheus",'."\n" + .' "extras":{'."\n" + ."\n" + .' },'."\n" + .' "clusterId":"c39a1048921e04f***********",'."\n" + .' "sourceName":"arms-luyao-test",'."\n" + .' "dataSource":"",'."\n" + .' "userId":"1672753***********"'."\n" + .' },'."\n" + .' {'."\n" + .' "headers":{'."\n" + ."\n" + .' },'."\n" + .' "regionId":"cn-beijing",'."\n" + .' "sourceType":"AlibabaPrometheus",'."\n" + .' "extras":{'."\n" + ."\n" + .' },'."\n" + .' "clusterId":"c6b6485496d5b40***********",'."\n" + .' "sourceName":"agent-321-测试",'."\n" + .' "dataSource":"",'."\n" + .' "userId":"1672753***********"'."\n" + .' },'."\n" + .' {'."\n" + .' "headers":{'."\n" + ."\n" + .' },'."\n" + .' "regionId":"cn-zhangjiakou",'."\n" + .' "sourceType":"AlibabaPrometheus",'."\n" + .' "extras":{'."\n" + ."\n" + .' },'."\n" + .' "clusterId":"c261a4f3200c446***********",'."\n" + .' "sourceName":"zaifeng-cardinality-01",'."\n" + .' "dataSource":"",'."\n" + .' "userId":"1672753***********"'."\n" + .' }'."\n" + .']'], + ], + [ + 'name' => 'AllSubClustersSuccess', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether all sub-instances must pass validation before the GlobalView instance is created. Default value: false, which indicates that partial success is allowed.', 'type' => 'boolean', 'docRequired' => false, 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'GrafanaInstanceId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the bound Grafana workspace. Set this parameter to "free" when you use the shared Grafana edition.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'grafana-bp1*****'], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'rg-acfmxyexli2****'], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The status of the file. Valid values: SUCCESS and INIT.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The custom tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey'], + 'Value' => ['title' => '', 'description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue'], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'SUCCESS', + 'example' => '['."\n" + .' {'."\n" + .' "labelName":"labelValue"'."\n" + .' },'."\n" + .' {'."\n" + .' "testName":"clusterA"'."\n" + .' }'."\n" + .']', + 'maxItems' => 21, ], ], [ - 'name' => 'RegionId', + 'name' => 'Duration', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The data storage duration, in days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90'], + ], + [ + 'name' => 'ArchiveDuration', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of days to automatically archive data after the storage period expires. Valid values: 60, 90, 180, and 365. A value of 0 indicates that data is not archived.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90'], + ], + [ + 'name' => 'PaymentType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'title' => '', + 'description' => 'The Billable methods. Valid values:'."\n" + .'POSTPAY: pay-as-you-go based on the number of reported metrics.'."\n" + .'POSTPAY_GB: pay-as-you-go based on the volume of written metrics.'."\n" + .'Empty: uses the default billing method configured by the user. If no default is configured, the system defaults to billing based on the number of reported metrics.', 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'enum' => ['POSTPAY', 'POSTPAY_GB'], + 'required' => false, + 'example' => 'POSTPAY', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', - ], + 'Data' => ['title' => '', 'description' => 'The instance ID returned after the instance is created.'."\n" + ."\n" + .'- For aliyun-cs instances, the Prometheus instance ID is the Container Service cluster ID.'."\n" + ."\n" + .'- For ecs instances, the Prometheus instance ID is the VPC ID.', 'type' => 'string', 'example' => 'qduukd****'], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '70675725-8F11-4817-8106-CFE0AD71****', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. Valid values:'."\n" + ."\n" + .'- 2XX: success.'."\n" + .'- 3XX: redirection.'."\n" + .'- 4XX: request error.'."\n" + .'- 5XX: server error.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Create a prometheus instance', + 'changeSet' => [ + ['createdAt' => '2024-12-13T07:36:22.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-05T01:37:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-04-12T03:44:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-28T02:09:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-17T02:09:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-11T08:02:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-29T09:02:31.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\"\\n}","type":"json"}]', - 'title' => 'UpdateRumFileStatus', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'GetRumUploadFiles' => [ - 'summary' => 'Queries Real User Monitoring (RUM)-related files, such as symbol tables and SourceMap.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreatePrometheusInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"qduukd****\\",\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'CreatePrometheusMonitoring' => [ + 'summary' => 'Creates a monitoring configuration for a Prometheus instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AppType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The file type. Valid values: source-map: SourceMap files. mapping: symbol table files for Android. dsym: dSYM files for iOS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'source-map', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID (PID) of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aoxxxxxly@741623b4e91****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], ], [ - 'name' => 'RegionId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The type of the monitoring configuration. '."\n" + .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" + .'Valid values for a Prometheus instance for ECS: customJob and probe.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serviceMonitor'], ], [ - 'name' => 'VersionId', + 'name' => 'Status', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The status of the monitoring configuration. Valid values: run and stop. Default value: run. This parameter is not available if the Type parameter is set to Probe.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'run'], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['title' => '', 'description' => 'The monitoring configuration. Specify a YAML string.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '参见请求参数补充说明。'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The version number of the files. If you do not specify this parameter, all versions of the files are returned by default.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The name of the monitoring configuration that was added, or the exception information.'."\n", 'type' => 'string', 'example' => 'name1'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'CreatePrometheusMonitoring', + 'requestParamsDescription' => 'ServiceMonitor example:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: ServiceMonitor'."\n" + .' metadata:'."\n" + .' name: tomcat-demo'."\n" + .' namespace: default'."\n" + .' spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' path: /metrics'."\n" + .' port: tomcat-monitor'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: tomcat'."\n" + ."\n" + .'PodMonitor example:'."\n" + ."\n" + .' apiVersion: "monitoring.coreos.com/v1"'."\n" + .' kind: "PodMonitor"'."\n" + .' metadata:'."\n" + .' name: "podmonitor-demo"'."\n" + .' namespace: "default"'."\n" + .' spec:'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: "30s"'."\n" + .' path: "/metrics"'."\n" + .' port: "tomcat-monitor"'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: "nginx2-exporter"'."\n" + ."\n" + .'CustomJob example:'."\n" + ."\n" + .' scrape_configs:'."\n" + .' - job_name: prometheus1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + ."\n" + .'Probe example:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: Probe'."\n" + .' metadata:'."\n" + .' name: name1-tcp-blackbox #Rule: xxx-{tcp/http/ping}-blackbox'."\n" + .' namespace: arms-prom # Optional.'."\n" + .' spec:'."\n" + .' interval: 30s'."\n" + .' jobName: blackbox'."\n" + .' module: tcp_connect'."\n" + .' prober:'."\n" + .' path: /blackbox/probe'."\n" + .' scheme: http'."\n" + .' url: \'localhost:9335\''."\n" + .' targets:'."\n" + .' staticConfig:'."\n" + .' static:'."\n" + .' - \'arms-prom-admin.arms-prom:9335\''."\n", + 'changeSet' => [ + ['createdAt' => '2023-05-26T03:36:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-26T03:16:13.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-26T03:04:32.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-09T05:40:50.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusMonitoring'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"name1\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'CreateRetcodeApp' => [ + 'summary' => 'Creates a Browser Monitoring task for an application.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'PageSize', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'RetcodeAppName', 'in' => 'query', - 'schema' => [ - 'type' => 'integer', - 'format' => 'int32', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'SdkTest', 'title' => ''], ], [ - 'name' => 'NextToken', + 'name' => 'RetcodeAppType', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* `web`: web application'."\n" + .'* `weex`: Weex mobile app'."\n" + .'* `mini_dd`: DingTalk mini program'."\n" + .'* `mini_alipay`: Alipay mini program'."\n" + .'* `mini_wx`: WeChat mini program'."\n" + .'* `mini_common`: mini program on other platforms'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'mini_dd', 'title' => ''], ], [ - 'name' => 'FileName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Workspace', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ - 'name' => 'ServiceId', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The tags that you want to add to the task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\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', - ], - 'Data' => [ - 'description' => 'The queried files.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The response parameters.', 'type' => 'string', 'example' => 'bdidt76ehx@d5cf1cd3f7df411', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'- true: The call was successful.'."\n" + .'- false: The call failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RetcodeAppDataBean' => [ + 'description' => 'The information of the Browser Monitoring task.'."\n", 'type' => 'object', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'FileName' => [ - 'name' => 'FileName', - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'example' => 'test.js.map', - 'backendName' => 'fileName', - ], - 'Uuid' => [ - 'name' => 'Uuid', - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'example' => 'cxxxerfewrfwerfwerffvrt', - 'backendName' => 'uuid', - ], - 'Size' => [ - 'name' => 'Size', - 'description' => 'The size of the file. Unit: bytes.'."\n", - 'type' => 'string', - 'example' => '1000', - 'backendName' => 'size', - ], - 'LastModifiedTime' => [ - 'name' => 'LastModifiedTime', - 'description' => 'The time when the file was last modified. The value is a timestamp.'."\n", - 'type' => 'any', - 'example' => '1682863151000', - 'backendName' => 'updateTime', - ], - 'VersionId' => [ - 'name' => 'VersionId', - 'description' => 'The version number of the file.'."\n", - 'type' => 'string', - 'example' => '1.0.0', - 'backendName' => 'versionId', - ], - ], - 'extendType' => 'true', - ], 'properties' => [ - 'FileList' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'VersionId' => [ - 'type' => 'string', - ], - 'Uuid' => [ - 'type' => 'string', - ], - 'Size' => [ - 'type' => 'string', - ], - 'FileName' => [ - 'type' => 'string', - ], - 'LastModifiedTime' => [ - 'type' => 'any', + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'aokcdqn3ly@a195c6d6421****', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '135143', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tags' => [ + 'description' => 'The tags of the task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], - ], - 'NextToken' => [ - 'type' => 'string', + 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FileList\\": [\\n {\\n \\"VersionId\\": \\"\\",\\n \\"Uuid\\": \\"\\",\\n \\"Size\\": \\"\\",\\n \\"FileName\\": \\"\\",\\n \\"LastModifiedTime\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetRumUploadFiles', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'GetRumDataForPage' => [ - 'summary' => 'Queries Real User Monitoring (RUM) data by page.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"bdidt76ehx@d5cf1cd3f7df411\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"RetcodeAppDataBean\\": {\\n \\"Pid\\": \\"aokcdqn3ly@a195c6d6421****\\",\\n \\"AppId\\": 135143,\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Tags\\": {\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateRetcodeAppResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C647A</RequestId>\\n <RetcodeAppDataBean>\\n <AppId>135143</AppId>\\n <Pid>aokcdqn3ly@a195c6d6421****</Pid>\\n </RetcodeAppDataBean>\\n</CreateRetcodeAppResponse>","errorExample":""}]', + 'title' => 'CreateRetcodeApp', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-27T11:18:37.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-27T07:44:39.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-26T08:02:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-07-19T09:58:03.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'CreateRumApp' => [ + 'summary' => 'Create a Real User Monitoring (RUM) application.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8066,98 +5549,90 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '197708', - 'abilityTreeNodes' => [ - 'FEATUREarmsH2Y9JL', - ], + 'abilityTreeCode' => '194698', + 'abilityTreeNodes' => ['FEATUREarmsRY7LT8'], ], 'parameters' => [ [ - 'name' => 'Query', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'A query statement that complies with the query syntax of Simple Log Service Logstore. For more information, see the parameters corresponding to this operation on the console page.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '* and app.id: xxxx@586810fbxxxx19f '."\n", - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'Pid', + 'name' => 'SiteType', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'iixxxjcnuk@582846f37******', - ], + 'schema' => ['description' => 'The application type. Valid values: web, miniapp, ios, and android.'."\n", 'type' => 'string', 'required' => true, 'example' => 'web', 'title' => ''], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => ['description' => 'The source. This is a reserved parameter.', 'type' => 'string', 'required' => false, 'example' => 'arms', 'title' => ''], ], [ 'name' => 'AppGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The group to which the application belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The name of the application group.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The time is accurate to seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1713687833', - ], + 'schema' => ['description' => 'The description of the application.', 'type' => 'string', 'required' => false, 'example' => '用户体验监控前端', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The time is accurate to seconds.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1713774233', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', + 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'app', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ecs', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '20', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CurrentPage', + 'name' => 'PackageName', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the Android application package. This parameter is required if you create an Android application.', 'type' => 'string', 'required' => false, 'example' => 'com.xxxx.xxxxxx', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'NickName', + 'in' => 'query', + 'schema' => ['description' => 'The nickname of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], + ], + [ + 'name' => 'RealRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-finance-1', 'title' => ''], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => ['description' => 'The language used by the client.'."\n", 'type' => 'string', 'required' => false, 'example' => 'java', 'title' => ''], ], ], 'responses' => [ @@ -8167,100 +5642,50 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'description' => 'The responses code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'StartTime is mandatory for this action.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****'], + 'Code' => ['description' => 'The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['title' => 'Id of the request', 'description' => 'The error message.'."\n", 'type' => 'string', 'example' => '应用已存在。'], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The result of the operation.'."\n", + 'description' => 'The application ID and domain names. This parameter is returned if the application is created. Multiple domain names are separated with commas (,).'."\n", 'type' => 'object', 'properties' => [ - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'string', - 'example' => '7', - ], - 'Page' => [ - 'description' => 'The page number.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'string', - 'example' => '20', - ], - 'Authentication' => [ - 'description' => 'A reserved parameter. Ignore this parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Completion' => [ - 'description' => 'Indicates whether the query ends. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Preference' => [ - 'description' => 'A reserved parameter. Ignore this parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Items' => [ - 'description' => 'The queried data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the queried data, in the JSON Map format.'."\n", - 'type' => 'object', - 'example' => 'null', - ], - ], + 'Pid' => ['description' => 'The process ID (PID) of the application.'."\n", 'type' => 'string', 'example' => 'avccccxxxx@24cxxxxbf384dc6', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint that is used to report application data.'."\n", 'type' => 'string', 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', 'title' => ''], + 'CdnDomain' => ['description' => 'The domain name of the SDK.'."\n", 'type' => 'string', 'example' => 'bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js', 'title' => ''], ], + 'example' => 'ggxxxnjuz@xxxx,xxxxxx-default-cn.rum.aliyuncs.com', + 'title' => '', ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"应用已存在。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Pid\\": \\"avccccxxxx@24cxxxxbf384dc6\\",\\n \\"Endpoint\\": \\"xxxxxxxx-default-cn.rum.aliyuncs.com\\",\\n \\"CdnDomain\\": \\"bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js\\"\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n}","type":"json"}]', + 'title' => 'CreateRumApp', + 'changeSet' => [ + ['createdAt' => '2025-05-06T08:54:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T02:00:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-07T03:50:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-02T10:53:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-12T06:05:50.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-28T09:09:56.000Z', 'description' => 'Response parameters changed'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"内部错误，请联系管理员。\\\\n\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Total\\": \\"7\\",\\n \\"Page\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"Authentication\\": \\"保留字段，请忽略。\\",\\n \\"Completion\\": \\"true\\",\\n \\"Preference\\": \\"保留字段，请忽略。\\\\n\\\\n\\",\\n \\"Items\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetRumDataForPage', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", ], 'CreateRumUploadFileUrl' => [ - 'summary' => 'Creates a file upload URL to upload SourceMap files, symbol table files, or dSYM files.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -8268,264 +5693,639 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID (PID) of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'iioe7jcnuk@582846f37******', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'iioe7jcnuk@582846f37******', 'title' => ''], ], [ 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The version number of the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.0.0', - ], + 'schema' => ['description' => 'The file version.', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''], ], [ 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '125bdb39-a415-4503-bd96-e293925fc64c', - ], + 'schema' => ['description' => 'The UUID of the file.', 'type' => 'string', 'required' => false, 'example' => '125bdb39-a415-4503-bd96-e293925fc64c', 'title' => ''], ], [ 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => 'The file name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'test.js.map', - ], + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => true, 'example' => 'test.js.map', 'title' => ''], ], [ 'name' => 'ContentType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the file. You can set this parameter to "application/zip", "text/plain", or an empty string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'text/plain', - ], + 'schema' => ['description' => 'The file type. Valid values include `"application/zip"` and `"text/plain"`. You can also pass an empty string.', 'type' => 'string', 'required' => false, 'example' => 'text/plain', 'title' => ''], ], [ 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The application name.', 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], [ 'name' => 'SourcemapType', 'in' => 'query', - 'schema' => [ - 'description' => 'The file type. Valid values: source-map: SourceMap files. mapping: symbol table files for Android. dsym: dSYM files for iOS.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'source-map', - ], + 'schema' => ['description' => 'The file type. Valid values:'."\n" + ."\n" + .'- source-map: a source map file'."\n" + ."\n" + .'- mapping: an Android symbol table file'."\n" + ."\n" + .'- dsym: an iOS dSYM file', 'type' => 'string', 'required' => false, 'example' => 'source-map', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'Workspace', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response body.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'Code' => [ - 'description' => 'The response code. 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', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The file upload URL.'."\n", - 'type' => 'string', - 'example' => 'http://arms-rum-v2.oss-cn-hangzhou.aliyuncs.com/113197164xxxxx28/b590lhguqs%40f93xxxxxbf31d3/1.0.0-robots.txt?Expires=1713847079&OSSAccessKeyId=STS.NT6XvoxkyqA&Signature=6ptYX4OTjLMrsleTlA2t97', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', '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' => ''], + 'Message' => ['description' => 'The error message that is returned if the request fails.', 'type' => 'string', 'example' => '内部错误，请联系管理员。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The file upload link.', 'type' => 'string', 'example' => 'http://arms-rum-v2.oss-cn-hangzhou.aliyuncs.com/113197164xxxxx28/b590lhguqs%40f93xxxxxbf31d3/1.0.0-robots.txt?Expires=1713847079&OSSAccessKeyId=STS.NT6XvoxkyqA&Signature=6ptYX4OTjLMrsleTlA2t97', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"http://arms-rum-v2.oss-cn-hangzhou.aliyuncs.com/113197164xxxxx28/b590lhguqs%40f93xxxxxbf31d3/1.0.0-robots.txt?Expires=1713847079&OSSAccessKeyId=STS.NT6XvoxkyqA&Signature=6ptYX4OTjLMrsleTlA2t97\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'CreateRumUploadFileUrl', - 'description' => 'This operation returns a URL. You can upload files to the URL. For more information, see [Upload local files with signed URLs](~~2579659~~).'."\n", - ], - 'DeleteRumUploadFile' => [ - 'summary' => 'Deletes a file such as a symbol table or SourceMap.', - 'methods' => [ - 'post', - 'get', + 'summary' => 'Generates a presigned URL for uploading application artifacts, such as source map files, symbol table files, and dSYM files.', + 'description' => 'This operation returns a presigned URL for uploading a file. For instructions, see [Upload files by using URLs](~~2579659~~).', + 'changeSet' => [ + ['createdAt' => '2025-08-22T06:39:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-16T07:53:56.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateRumUploadFileUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"http://arms-rum-v2.oss-cn-hangzhou.aliyuncs.com/113197164xxxxx28/b590lhguqs%40f93xxxxxbf31d3/1.0.0-robots.txt?Expires=1713847079&OSSAccessKeyId=STS.NT6XvoxkyqA&Signature=6ptYX4OTjLMrsleTlA2t97\\"\\n}","type":"json"}]', + ], + 'CreateSyntheticTask' => [ + 'summary' => 'Creates or updates a synthetic monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region in which the application is located.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'TaskName', 'in' => 'query', + 'schema' => ['description' => 'The name of the task. To update a synthetic monitoring task, enter the task name and set the **UpdateTask** parameter to **true**.'."\n", 'type' => 'string', 'required' => true, 'example' => '网络拨测任务', 'title' => ''], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['description' => 'The URL for synthetic monitoring.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://www.example.com', 'title' => ''], + ], + [ + 'name' => 'MonitorList', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'atc889zkcf@d8deedfa9bf****', + 'description' => 'The list of monitoring points.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CityCode' => ['description' => 'The ID of the city to which the monitoring point belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1100101', 'title' => ''], + 'NetServiceId' => ['description' => 'The ID of the carrier.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '18', 'title' => ''], + 'MonitorType' => ['description' => 'The carrier type:'."\n" + ."\n" + .'* IDC'."\n" + .'* LastMilie'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => 'IDC', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'VersionId', + 'name' => 'TaskType', 'in' => 'query', + 'schema' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'1. 3: web page performance - IE'."\n" + .'2. 34: web Page Performance - Chrome'."\n" + .'3. 0: network quality'."\n" + .'4. 40: file download'."\n" + .'5. 7:API performance'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'IntervalTime', + 'in' => 'query', + 'schema' => ['description' => 'The interval at which synthetic monitoring is performed. Unit: minutes. Valid values:'."\n" + ."\n" + .'* 1'."\n" + .'* 5'."\n" + .'* 10'."\n" + .'* 15'."\n" + .'* 20'."\n" + .'* 30'."\n" + .'* 60'."\n" + .'* 120'."\n" + .'* 180'."\n" + .'* 240'."\n" + .'* 360'."\n" + .'* 480'."\n" + .'* 720'."\n" + .'* 1440'."\n", 'type' => 'string', 'required' => true, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'IntervalType', + 'in' => 'query', + 'schema' => ['description' => 'The interval type.'."\n" + ."\n" + .'* 0: daily'."\n" + .'* 1: custom frequency'."\n", 'type' => 'string', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'ExtendInterval', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The version number of the file.'."\n", - 'type' => 'string', + 'description' => 'The frequency.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The time when synthetic monitoring starts. The format is `yyyy-MM-dd HH`.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-07-20 10', 'title' => ''], + 'EndTime' => ['description' => 'The time when synthetic monitoring ends. The format is `yyyy-MM-dd HH`.'."\n", 'type' => 'string', 'required' => false, 'example' => '2022-08-20 10', 'title' => ''], + 'Days' => [ + 'description' => 'The day on which synthetic monitoring is performed.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The day on which synthetic monitoring is performed.'."\n" + ."\n" + .'* \\-1: every day'."\n" + .'* 0: Sunday'."\n" + .'* 1: Monday'."\n" + .'* 2: Tuesday'."\n" + .'* 3: Wednesday'."\n" + .'* 4: Thursday'."\n" + .'* 5: Friday'."\n" + .'* 6: Saturday'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '-1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'StartHour' => ['description' => 'The hour at which synthetic monitoring starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '00', 'title' => ''], + 'StartMinute' => ['description' => 'The minute at which synthetic monitoring starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '00', 'title' => ''], + 'EndHour' => ['description' => 'The hour at which synthetic monitoring ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '23', 'title' => ''], + 'EndMinute' => ['description' => 'The minute at which synthetic monitoring ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '00', 'title' => ''], + ], 'required' => false, - 'example' => '1.0.0', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Uuid', + 'name' => 'IpType', + 'in' => 'query', + 'schema' => ['description' => 'The IP address type:'."\n" + ."\n" + .'* 0: an automatic IP address'."\n" + .'* 1: IPv4'."\n" + .'* 2: IPv6'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '0', 'title' => ''], + ], + [ + 'name' => 'Net', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The file ID.'."\n", - 'type' => 'string', + 'description' => 'The network synthetic monitoring task.'."\n", + 'type' => 'object', + 'properties' => [ + 'NetICMPSwitch' => ['description' => 'Specifies whether to enable ping monitoring.'."\n" + ."\n" + .'* 0: Off.'."\n" + .'* 1: On. You must set Internet control message protocol (ICMP) parameters if you want to enable ping monitoring.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NetICMPActive' => ['description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* 0: ICMP'."\n" + .'* 1: TCP'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'NetICMPInterval' => ['description' => 'The interval at which the network synthetic monitoring task is executed. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NetICMPNum' => ['description' => 'The number of packages.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '4', 'title' => ''], + 'NetICMPSize' => ['description' => 'The package size.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '32', 'title' => ''], + 'NetDNSSwitch' => ['description' => 'Specifies whether to enable domain name system (DNS) monitoring.'."\n" + ."\n" + .'* 0: Off.'."\n" + .'* 1: On. You must set DNS parameters if you want to enable DNS monitoring.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NetDNSTimeout' => ['description' => 'The timeout period of DNS monitoring. Default value: 5 seconds. Valid values: 0 to 45 seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5', 'title' => ''], + 'NetDNSQueryMethod' => ['description' => 'The DNS query method. Valid values:'."\n" + ."\n" + .'* 1: recursion'."\n" + .'* 2: iteration'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NetDNSNs' => ['description' => 'The DNS server.'."\n", 'type' => 'string', 'required' => false, 'example' => '114.114.XX.XX', 'title' => ''], + 'NetDigSwitch' => ['description' => 'Specifies whether to display the data in the DIG format. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'NetDNSServer' => ['description' => 'The IP address type of the DNS server.'."\n" + ."\n" + .'* 0: IPv4'."\n" + .'* 1: IPv6'."\n" + .'* 2: an automatic IP address'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'NetTraceRouteSwitch' => ['description' => 'Specifies whether to enable tracert monitoring.'."\n" + ."\n" + .'* 0: Off.'."\n" + .'* 1: On. You must set the tracert parameters if you want to enable tracert monitoring.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NetTraceRouteTimeout' => ['description' => 'The timeout period of tracert monitoring. Valid values: 0 to 300 seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60', 'title' => ''], + 'NetTraceRouteNum' => ['description' => 'The maximum number of active monitoring points.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + 'WhiteList' => ['description' => 'The whitelist for DNS hijacking. The format is `Domain name: Matching rule`.'."\n" + ."\n" + .'> Wireless application protocol (WAP) networks do not support DNS hijacking.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:202.0.3.55|203.3.44.67', 'title' => ''], + 'NetICMPTimeout' => ['description' => 'The timeout period of Ping monitoring.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20', 'title' => ''], + 'NetICMPDataCut' => ['description' => 'Specifies whether to split packages.'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], 'required' => false, - 'example' => 'MS4wLjAtbWFpbi4wZjM0NzRlOSxxxxxx', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'FileName', + 'name' => 'CommonParam', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The file name, with the extension.'."\n", - 'type' => 'string', + 'description' => 'The common parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlarmFlag' => ['description' => 'Specifies whether to create an alert rule.'."\n" + ."\n" + .'* 1: creates an alert.'."\n" + .'* 0: does not create an alert.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'AlertList' => [ + 'description' => 'The alert parameters.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the alert rule.'."\n" + ."\n" + .'For network synthetic monitoring, use the following names:'."\n" + ."\n" + .'* Latency: PING_SET'."\n" + .'* Packet loss rate: PING_LOST_RATE'."\n" + .'* Hijacking: HIJACKPER'."\n", 'type' => 'string', 'required' => false, 'example' => 'PING_SET', 'title' => ''], + 'IsCritical' => ['description' => 'Specifies whether the condition must be met.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => 'true', 'title' => ''], + 'Symbols' => ['description' => 'Specifies how the condition is evaluated. Valid values:'."\n" + ."\n" + .'* 1: greater than'."\n" + .'* 0: less than'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'AlertPolicyId' => ['description' => 'The ID of the notification policy.'."\n", 'type' => 'string', 'required' => false, 'example' => '1234', 'title' => ''], + 'AlertNotifierId' => ['description' => 'The ID of the alert recipient. Separate multiple recipients with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], + 'StartExecutionTime' => ['description' => 'The time when execution starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2022-07-20 10', 'title' => ''], + 'MonitorSamples' => ['description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], 'required' => false, - 'example' => 'test.js.map', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RegionId', + 'name' => 'Navigation', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'description' => 'The monitoring items that are associated with the browse tasks.'."\n", + 'type' => 'object', + 'properties' => [ + 'NavDisableCache' => ['description' => 'Specifies whether to disable caching.'."\n" + ."\n" + .'* 1: disable'."\n" + .'* 0: enable'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NavReturnElement' => ['description' => 'Specifies whether to return the elements on the page.'."\n" + ."\n" + .'* 1: no. Returns the basic document data.'."\n" + .'* 2: yes. Returns all document data.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + 'NavRedirection' => ['description' => 'Specifies whether to continue browsing after a redirection occurs.'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NavDisableCompression' => ['description' => 'Specifies whether to enable the feature of using the Accept-Encoding field to determine whether to accept compressed files.'."\n" + ."\n" + .'* 1: disable'."\n" + .'* 0: enable'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'NavAutomaticScrolling' => ['description' => 'Specifies whether to automatically scroll up and down the screen to load a page.'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'NavIgnoreCertificateError' => ['description' => 'Specifies whether to ignore certificate errors during certificate verification in the SSL handshake and continue browsing.'."\n" + ."\n" + .'* 1: ignore'."\n" + .'* 0: does not ignore'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'FilterInvalidIP' => ['description' => 'Specifies whether to filter invalid IP addresses.'."\n" + ."\n" + .'* 1: no'."\n" + .'* 0: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'ExecuteApplication' => ['description' => 'Specifies whether to run applets.'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n" + ."\n" + .'> This parameter is supported only by IE Full Elements.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'ExecuteActiveX' => ['description' => 'Specifies whether to execute ActiveX.'."\n" + ."\n" + .'* 3: yes'."\n" + .'* 0: no'."\n" + ."\n" + .'> This parameter is supported only by IE Full Elements.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + 'ExecuteScript' => ['description' => 'Specifies whether to execute scripts.'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n" + ."\n" + .'> This parameter is supported only by IE Full Elements.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'QUICVersion' => ['description' => 'The Quick UDP Internet Connections (QUIC) protocol version. Default value: 0. Valid values:'."\n" + ."\n" + .'*'."\n" + .'* 35'."\n" + .'* 39'."\n" + .'* 43'."\n" + .'* 44'."\n" + ."\n" + .'> This parameter is supported by all elements of only Chrome'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'QUICDomain' => ['description' => 'The domain name of the QUIC request element.'."\n" + ."\n" + .'> This parameter is supported by all elements of only Chrome'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.example.com', 'title' => ''], + 'RequestHeader' => ['description' => 'Specifies whether to return the request header.'."\n" + ."\n" + .'* 0: does not return the response header.'."\n" + .'* 1: returns the basic document header.'."\n" + .'* 2: returns all headers.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'NavCustomHost' => ['description' => 'The custom host mode.'."\n" + ."\n" + .'* 1: round robin'."\n" + .'* 0: random'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'NavCustomHostIp' => ['description' => 'The custom host IP address. You can enter multiple IP addresses. Separate the IP addresses with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com', 'title' => ''], + 'NavCustomHeader' => ['description' => 'The method that is used to customize the header. Valid values:'."\n" + ."\n" + .'* 0: disables the customer header.'."\n" + .'* 1: modifies the first package.'."\n" + .'* 2: modifies all packages.'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], + 'NavCustomHeaderContent' => ['description' => 'The format of the custom header. You can specify multiple fields. Separate the fields with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Host:www.example.com|Referer:www.example.com', 'title' => ''], + 'ElementBlacklist' => ['description' => 'The element blacklist.'."\n", 'type' => 'string', 'required' => false, 'example' => '*.a.com', 'title' => ''], + 'ProcessName' => ['description' => 'The process ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ssh', 'title' => ''], + 'VerifyStringBlacklist' => ['description' => 'The blacklist for string verification.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Regex:*.example|expalme|', 'title' => ''], + 'VerifyStringWhiteList' => ['description' => 'The whitelist for string verification.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Regex:*.example|expalme|', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The timeout period of monitoring. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + 'WaitCompletionTime' => ['description' => 'The timeout period of waiting for the monitoring to complete.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '15', 'title' => ''], + 'SlowElementThreshold' => ['description' => 'The time threshold that is used to define a slow element. Unit: seconds.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '5', 'title' => ''], + 'DNSHijackWhiteList' => ['description' => 'The whitelist for DNS hijacking.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:202.0.3.55|203.3.44.67', 'title' => ''], + 'PageTamper' => ['description' => 'The web page defacement.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.example.com:202.0.3.55|203.3.44.67', 'title' => ''], + 'FlowHijackJumpTimes' => ['description' => 'The element that is used in DNS hijacking.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '50', 'title' => ''], + 'FlowHijackLogo' => ['description' => 'The tag that is used in DNS hijacking.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], + 'ResponseHeader' => ['description' => 'The method that is used to return the response header. Valid values:'."\n" + ."\n" + .'* 0: does not return the response header.'."\n" + .'* 1: returns the basic document header.'."\n" + .'* 2: returns all headers.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'BatchItems', + 'name' => 'Download', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Information of files to be deleted in JSON array format. If a single file needs to be deleted, this field should be left empty. If multiple files need to be deleted, just fill in this field.', - 'type' => 'string', + 'description' => 'The file download task.'."\n", + 'type' => 'object', + 'properties' => [ + 'DownloadTransmissionSize' => ['description' => 'The size of the download file. Unit: KB.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10240', 'title' => ''], + 'DownloadCustomHost' => ['description' => 'The custom host mode.'."\n" + ."\n" + .'* 1: round robin'."\n" + .'* 0: random'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'DownloadCustomHostIp' => ['description' => 'The custom host IP address. You can enter multiple IP addresses. Separate the IP addresses with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com', 'title' => ''], + 'WhiteList' => ['description' => 'The whitelist for DNS hijacking.'."\n", 'type' => 'string', 'required' => false, 'example' => '[{\\"src\\":\\"211.154.166.174\\"}]', 'title' => ''], + 'DownloadKernel' => ['description' => 'The kernel type.'."\n" + ."\n" + .'* 1: curl'."\n" + .'* 0: WinInet'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'QuickProtocol' => ['description' => 'The QUIC protocol type.'."\n" + ."\n" + .'* 1: http1'."\n" + .'* 2: http2'."\n" + .'* 3: http3'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring duration.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '30', 'title' => ''], + 'ConnectionTimeout' => ['description' => 'The connection timeout period.'."\n", 'type' => 'number', 'format' => 'double', 'required' => false, 'example' => '200', 'title' => ''], + 'VerifyWay' => ['description' => 'The verification method.'."\n" + ."\n" + .'* 0: no verification'."\n" + .'* 1: string verification'."\n" + .'* 2: MD5 verification'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'ValidateKeywords' => ['description' => 'The keyword that is used in verification.'."\n", 'type' => 'string', 'required' => false, 'example' => 'keyword', 'title' => ''], + 'DownloadRedirection' => ['description' => 'Specifies whether to support redirection.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'DownloadCustomHeaderContent' => ['description' => 'The items to be ignored in a certificate error. Pass the values of the check boxes that are separated with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => 'Host:www.example.com|Referer:www.example.com', 'title' => ''], + 'DownloadIgnoreCertificateError' => ['description' => 'The items to be ignored in a certificate error. Pass the values of the check boxes that are separated with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => '1|2|4', 'title' => ''], + ], 'required' => false, - 'example' => '[{'."\n" - .' "fileName" : "test.js.map",'."\n" - .' "version" : "1.0.0"'."\n" - .' },'."\n" - .' {'."\n" - .' "fileName" : "test.dSYM",'."\n" - .' "version" : "1.20.1",'."\n" - .' "uuid" : "xxxx-xxxx-xxxx-xxxx"'."\n" - .' }]', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Workspace', + 'name' => 'Protocol', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'string', + 'description' => 'The API performance synthetic monitoring task.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestContent' => [ + 'description' => 'The request content, including the request header and request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => ['description' => 'The request method.'."\n" + ."\n" + .'* POST'."\n" + .'* GET'."\n", 'type' => 'string', 'required' => false, 'example' => 'POST', 'title' => ''], + 'Header' => [ + 'description' => 'The custom header of a request to initiate an API performance synthetic monitoring task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the request header.'."\n", 'type' => 'string', 'required' => false, 'example' => 'regionId', 'title' => ''], + 'Value' => ['description' => 'The value of the request header.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Body' => [ + 'description' => 'The custom body of a request to initiate an API performance synthetic monitoring task.'."\n", + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => 'The data type of the content.'."\n" + ."\n" + .'* form-data'."\n" + .'* x-www-form-urlencoded'."\n" + .'* raw'."\n", 'type' => 'string', 'required' => false, 'example' => 'form-data', 'title' => ''], + 'FormData' => [ + 'description' => 'The data that is passed when the **Mode** parameter is set to **form-data**.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of **form-data**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'appId', 'title' => ''], + 'Value' => ['description' => 'The value of **form-data**.'."\n", 'type' => 'string', 'required' => false, 'example' => '3425', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'UrlEncoding' => [ + 'description' => 'The data that is passed when the **Mode** parameter is set to **x-www-form-urlencoded**.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of **x-www-form-urlencoded**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'appId', 'title' => ''], + 'Value' => ['description' => 'The value of **x-www-form-urlencoded**.'."\n", 'type' => 'string', 'required' => false, 'example' => '11080', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Raw' => ['description' => 'The data that is passed when the **Mode** parameter is set to **raw**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'content', 'title' => ''], + 'Language' => ['description' => 'The language that is selected when the Mode parameter is set to raw.'."\n" + ."\n" + .'* json'."\n" + .'* xml'."\n" + .'* javascript'."\n" + .'* html'."\n" + .'* text'."\n", 'type' => 'string', 'required' => false, 'example' => 'json', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CharacterEncoding' => ['description' => 'The encoding format.'."\n" + ."\n" + .'* 0: UTF-8'."\n" + .'* 1: GBK'."\n" + .'* 2: GB2312'."\n" + .'* 3: Unicode'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'VerifyWay' => ['description' => 'The method that is used to verify the response content.'."\n" + ."\n" + .'* 0: no verification.'."\n" + .'* 1: exact match with the verification string.'."\n" + .'* 2: partial match with the verification string.'."\n" + .'* 3: MD5 verification.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], + 'VerifyContent' => ['description' => 'The verification string.'."\n", 'type' => 'string', 'required' => false, 'example' => '"code":200', 'title' => ''], + 'ReceivedDataSize' => ['description' => 'The size of the received data. This parameter is required when you set the value of the VerifyWay parameter to 2.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '500', 'title' => ''], + 'ProtocolMonitorTimeout' => ['description' => 'The timeout period of API performance synthetic monitoring. Unit: seconds.'."\n", 'type' => 'string', 'required' => false, 'example' => '30', 'title' => ''], + 'CustomHost' => ['description' => 'The custom host mode.'."\n" + ."\n" + .'* 1: round robin'."\n" + .'* 0: random'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + 'CustomHostIp' => ['description' => 'The custom host IP address. You can enter multiple IP addresses. Separate the IP addresses with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => 'ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com', 'title' => ''], + 'ProtocolConnectionTime' => ['description' => 'The connection timeout period of the protocol. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '3', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ServiceId', + 'name' => 'UpdateTask', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['description' => 'Specifies whether to update existing synthetic monitoring tasks.'."\n" + ."\n" + .'* true: updates existing synthetic monitoring tasks.'."\n" + .'* false: creates new synthetic monitoring tasks.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -8535,529 +6335,562 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'Internal error, please contact the administrator.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'Code' => ['description' => 'The status code returned.'."\n" + ."\n" + .'* 1001: The request was successful.'."\n" + .'* 1002: The request failed.'."\n" + .'* 1003: Parameter errors occurred.'."\n" + .'* 1004: Authentication failed.'."\n" + .'* 1006: The task does not exist.'."\n" + .'* 1099: Internal errors occurred.'."\n", 'type' => 'string', 'example' => '1001', 'title' => ''], + 'Msg' => ['description' => 'The message that is returned when the task failed to be created.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the file is deleted. If the file is deleted, "success" is returned.'."\n", - 'type' => 'string', - 'example' => 'success', + 'description' => 'The information about the synthetic monitoring task.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'title' => 'CreateSyntheticTask', + 'changeSet' => [ + ['createdAt' => '2022-08-25T11:32:26.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-12T06:39:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-11T12:08:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-22T04:00:52.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteRumUploadFile', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'GetRumAppInfo' => [ - 'summary' => 'Obtains the information about a single application in Browser Monitoring.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSyntheticTask'], + ], ], - 'schemes' => [ - 'https', + 'ramActions' => [ + [ + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": \\"1001\\",\\n \\"Msg\\": \\"null\\",\\n \\"Data\\": {\\n \\"TaskId\\": 1234\\n }\\n}","type":"json"}]', + ], + 'CreateTimingSyntheticTask' => [ + 'summary' => 'Creates a scheduled synthetic test task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '197299', - 'abilityTreeNodes' => [ - 'FEATUREarmsRY7LT8', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The process ID (PID) of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'atc889zkcf@d8deedfa9bf****', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'AppGroup', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The group to which the application belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['title' => '', 'description' => 'The name of the task.'."\n", 'type' => 'string', 'required' => true, 'example' => 'demo-test'], ], [ - 'name' => 'RegionId', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed measurement. 6: file download.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '4'], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'MonitorConf', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The monitoring configurations.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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', + 'NetICMP' => [ + 'title' => '', + 'description' => 'The parameters of the ICMP synthetic test. This parameter is required if the TaskType parameter is set to 1.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['title' => '', 'description' => 'The destination IP address or domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'www.example.com'], + 'Interval' => ['title' => '', 'description' => 'The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 2000. Default value: 200.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], + 'PackageNum' => ['title' => '', 'description' => 'The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'PackageSize' => [ + 'title' => '', + 'description' => 'The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024, 1080, and 1450.'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '32', + ], + 'SplitPackage' => ['title' => '', 'description' => 'Specifies whether to split ICMP packets. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'Timeout' => ['title' => '', 'description' => 'The timeout period for the ICMP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20000'], + 'TracertEnable' => ['title' => '', 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'TracertNumMax' => ['title' => '', 'description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'TracertTimeout' => ['title' => '', 'description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000'], + ], + 'required' => false, + 'example' => '', ], - 'Message' => [ - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'StartTime is mandatory for this action.', + 'NetTCP' => [ + 'title' => '', + 'description' => 'The parameters of the TCP synthetic test. This parameter is required if the TaskType parameter is set to 2.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['title' => '', 'description' => 'The IP address of the destination host.'."\n", 'type' => 'string', 'required' => true, 'example' => 'www.example.com'."\n"], + 'ConnectTimes' => ['title' => '', 'description' => 'The number of TCP connections that are established. Minimum value: 1. Maximum value: 16. Default value: 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4'], + 'Interval' => ['title' => '', 'description' => 'The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '200'], + 'Timeout' => ['title' => '', 'description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20000'], + 'TracertEnable' => ['title' => '', 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + 'TracertNumMax' => ['title' => '', 'description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20'], + 'TracertTimeout' => ['title' => '', 'description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000'], + ], + 'required' => false, + 'example' => '', ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', + 'NetDNS' => [ + 'title' => '', + 'description' => 'The parameters of the DNS synthetic test. This parameter is required if the TaskType parameter is set to 3.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['title' => '', 'description' => 'The destination domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'www.aliyun.com'], + 'DnsServerIpType' => ['title' => '', 'description' => 'The IP version of the DNS server.'."\n" + ."\n" + .'* 0 (default): IPv4.'."\n" + .'* 1: IPv6.'."\n" + .'* 2: A version is automatically selected.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'NsServer' => ['title' => '', 'description' => 'The IP address of the DNS server. Default value: 114.114.114.114.'."\n", 'type' => 'string', 'required' => false, 'example' => '114.114.114.114'], + 'QueryMethod' => ['title' => '', 'description' => 'The DNS query method. Valid values:'."\n" + ."\n" + .'* 0 (default): recursive'."\n" + .'* 1: iterative'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0'], + 'Timeout' => ['title' => '', 'description' => 'The timeout period for the DNS synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 45000. Default value: 5000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000'], + ], + 'required' => false, + 'example' => '', ], - 'Data' => [ - 'description' => 'The application details.'."\n", + 'ApiHTTP' => [ + 'description' => 'The parameters of the HTTP(S) synthetic test.'."\n", 'type' => 'object', 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the application was created. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'string', - 'example' => '1683353594000', - ], - 'Name' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'tomcat-demo-test', - ], - 'Pid' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'avccccefy0@24cccccbf384dc6', - ], - 'Type' => [ - 'description' => 'The type of the application. Valid value: RUM.'."\n", - 'type' => 'string', - 'example' => 'RUM', - ], - 'NickName' => [ - 'description' => 'The alias of the application.'."\n", - 'type' => 'string', - 'example' => 'nickname', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AppType' => [ - 'description' => 'The application type. Valid values: web, miniapp, ios, and android.'."\n", - 'type' => 'string', - 'example' => 'web', - ], - 'Status' => [ - 'description' => 'The status of the application. Valid values: created, running, and stopped.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2vezare****', - ], - 'IsSubscription' => [ - 'description' => 'Indicates whether the application is subscribed. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => 'Portal home page.', - ], - 'PackageName' => [ - 'description' => 'The name of the application package.'."\n", - 'type' => 'string', - 'example' => 'com.alibaba.rum', - ], - 'Endpoint' => [ - 'description' => 'The endpoint that is used to report application data.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', - ], - 'SlsProject' => [ - 'description' => 'The name of the Simple Log Service project that stores application data.'."\n", - 'type' => 'string', - 'example' => 'proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou', - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'Label', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'Value', - ], - ], - ], - ], - 'SlsLogstore' => [ - 'description' => 'The name of the Simple Log Service Logstore that stores application data.'."\n", - 'type' => 'string', - 'example' => 'logstore-rum', - ], - 'ServiceDomainConfigs' => [ - 'description' => 'The list of service domain configurations. Only mobile applications are supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A service domain configuration of the queried list.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name or IP address.'."\n", - 'type' => 'string', - 'example' => 'example.com', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'Tracing' => [ - 'description' => 'Indicates whether the tracing analysis feature is enabled. To enable the tracing analysis feature, you must activate Managed Service for OpenTelemetry. Valid values:'."\n" - ."\n" - .'* `true`: enables the tracing analysis feature. If you enable the tracing analysis feature, related headers are inserted into requests for the domain name.'."\n" - .'* `false`: disables the tracing analysis feature.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'PropagatorTypes' => [ - 'description' => 'The trace propagation protocols. This parameter is required if the tracing analysis feature is enabled.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The trace propagation protocol. Valid values: sw6 and sw8. sw6 indicates SkyWalking V2 and sw8 indicates SkyWalking V3.'."\n", - 'type' => 'string', - 'example' => 'sw8', - ], - ], - 'SamplingRate' => [ - 'description' => 'The sampling rate of a trace. Valid values: (0, 100].'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - ], - ], - ], - 'CdnDomain' => [ - 'description' => 'The domain name of the SDK.'."\n", - 'type' => 'string', - 'example' => 'b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js', + 'TargetUrl' => ['description' => 'The URL or request path for synthetic monitoring.'."\n", 'type' => 'string', 'required' => true, 'example' => 'http://www.demo.com/api/list', 'title' => ''], + 'Method' => ['description' => 'The request method. Valid values: GET and POST.'."\n", 'type' => 'string', 'required' => false, 'example' => 'GET', 'title' => ''], + 'RequestHeaders' => [ + 'description' => 'The HTTP request header.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'description' => 'Format: JSON map.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], - 'BonreeSDKConfig' => [ - 'description' => 'The collection configurations.'."\n", + 'RequestBody' => [ + 'description' => 'The HTTP request body.'."\n", 'type' => 'object', 'properties' => [ - 'moduleConfig' => [ - 'description' => 'The module configuration.'."\n", - 'type' => 'object', - 'properties' => [ - 'enable' => [ - 'description' => 'Indicates whether the configuration is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'defaultConfig' => [ - 'description' => 'The default configuration of the application.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'enable' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the configuration is enabled.'."\n", - 'example' => 'true', - ], - ], - 'description' => 'The module configuration.'."\n", - ], - ], - 'versionConfigs' => [ - 'description' => 'The version configurations of the application.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'useCustom' => [ - 'type' => 'boolean', - 'example' => 'true', - 'description' => 'Indicates whether the custom configuration is used.'."\n", - ], - 'customConfig' => [ - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'object', - 'properties' => [ - 'enable' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the configuration is enabled.'."\n", - 'example' => 'true', - ], - ], - 'description' => 'The module configuration.'."\n", - ], - 'description' => 'The custom configuration.'."\n", - ], - 'description' => [ - 'type' => 'string', - 'example' => 'test', - 'description' => 'The description of the version configuration.'."\n", - ], - 'updateTime' => [ - 'type' => 'integer', - 'format' => 'int64', - 'description' => 'The time when the version configuration was updated.'."\n", - 'example' => '1721112372055', - ], - ], - 'description' => 'The version configuration.'."\n", - ], - ], - ], - ], - 'samplingConfig' => [ - 'description' => 'Sampling configuration.', - 'type' => 'object', - 'properties' => [ - 'samplingType' => [ - 'description' => 'Sampling type, currently only session random sampling is supported, that is, fixed transmission: 1.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'samplingRate' => [ - 'description' => 'Sampling rate: between (0, 1000], a thousandth.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '500', - ], - ], - ], + 'Content' => ['description' => 'The content of the request body. Format: JSON string. The parameter is required if the Type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.'."\n", 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'title' => ''], + 'Type' => ['description' => 'The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.'."\n", 'type' => 'string', 'required' => false, 'example' => 'application/json', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'AppGroup' => [ - 'description' => 'The group to which the application belongs.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'BackendServiceTraceRegion' => [ - 'description' => 'The region where the backend is deployed.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'ConnectTimeout' => ['description' => 'The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10000', 'title' => ''], + 'CheckCert' => ['description' => 'Specifies whether to verify the certificate. Default value: no.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ProtocolAlpnProtocol' => ['description' => 'The ALPN protocol version. You can configure this parameter when you perform an HTTPS synthetic test on a WAP mobile client. Valid values:'."\n" + ."\n" + .'0: default'."\n" + ."\n" + .'1: http/1.1'."\n" + ."\n" + .'2: h2'."\n" + ."\n" + .'3: disables the ALPN protocol'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Website' => [ + 'description' => 'The parameters of the website speed measurement.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The URL of the website.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://www.aliyun.com', 'title' => ''], + 'AutomaticScrolling' => ['description' => 'Specifies whether to automatically scroll up and down the screen to load a page.'."\n" + ."\n" + .'* 0 (default): no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'CustomHeader' => ['description' => 'Specifies whether to create a custom header.'."\n" + ."\n" + .'* 0 (default): No custom header is created.'."\n" + .'* 1: A custom header is created for the first packet.'."\n" + .'* 2: A custom header is created for all packets.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The custom header. Format: JSON map.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'JSON Map'."\n", 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], - 'AppConfig' => [ - 'description' => 'The application configurations in the JSON format. This parameter is deprecated.'."\n", - 'type' => 'string', - 'example' => '{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}', + 'DisableCache' => ['description' => 'Specifies whether to disable caching.'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1 (default): yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'DisableCompression' => ['description' => 'Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. Valid values: 0: no. 1: yes. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'FilterInvalidIP' => ['description' => 'Specifies whether to exclude invalid IP addresses. Valid values: 0: yes. 1: no. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreCertificateError' => ['description' => 'Specifies whether to ignore certificate errors during certificate verification in the SSL handshake process and continue browsing. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period. Unit: milliseconds. This parameter is optional. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20000', 'title' => ''], + 'Redirection' => ['description' => 'Specifies whether to continue browsing after redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'SlowElementThreshold' => ['description' => 'The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'WaitCompletionTime' => ['description' => 'The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'VerifyStringBlacklist' => ['description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is in the blacklist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => 'error', 'title' => ''], + 'VerifyStringWhitelist' => ['description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is not in the whitelist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], + 'ElementBlacklist' => ['description' => 'The elements not to be loaded in the page loading process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.example.com/a.jpg', 'title' => ''], + 'DNSHijackWhitelist' => ['description' => 'If the IP address or CNAME record resolved from a domain name is not included in the DNS whitelist, you cannot access the domain name, or an IP address that belongs to a different domain name is returned. If the IP address or CNAME record is included in the DNS whitelist, DNS hijacking does not occur.'."\n" + ."\n" + .'Format: \\<domain name>:\\<objects>. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + 'PageTamper' => ['description' => 'Elements that are not included in the whitelist and appear on the page are tampered with. These elements can be pop-up ads, floating ads, and page redirection.'."\n" + ."\n" + .'Format: \\<domain name>:\\<elements>. The elements can be wildcard masks. Separate multiple elements with vertical bars (|). Example: www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg. It indicates that all elements that belong to the www.aliyun.com domain name except the basic documents, /cc/bb/a.gif, and /vv/bb/cc.jpg are tampered with.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', 'title' => ''], + 'FlowHijackJumpTimes' => ['description' => 'The total number of elements on the page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], + 'FlowHijackLogo' => ['description' => 'The keyword that is used to identify hijacking. Asterisks (\\*) are allowed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FileDownload' => [ + 'description' => 'The parameters of file downloading.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The URL that is used to download the file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png', 'title' => ''], + 'DownloadKernel' => ['description' => 'The kernel type. Valid values:'."\n" + ."\n" + .'* 1: curl'."\n" + .'* 0: WinInet'."\n" + ."\n" + .'Default value: 1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'QuickProtocol' => ['description' => 'The QUIC protocol type. Valid values:'."\n" + ."\n" + .'* 1: HTTP/1'."\n" + .'* 2: HTTP/2'."\n" + .'* 3: HTTP/3'."\n" + ."\n" + .'Default value: 1'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'ConnectionTimeout' => ['description' => 'Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The content of the custom request header.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'description' => 'Format: JSON map.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], - 'WebSDKConfigJson' => [ - 'type' => 'string', + 'IgnoreCertificateStatusError' => ['description' => 'Specifies whether to ignore certificate status errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'IgnoreCertificateUntrustworthyError' => ['description' => 'Specifies whether to ignore certificate incredibility. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'IgnoreInvalidHostError' => ['description' => 'Specifies whether to ignore host invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Redirection' => ['description' => 'Specifies whether to support redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'TransmissionSize' => ['description' => 'The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2048', 'title' => ''], + 'IgnoreCertificateCanceledError' => ['description' => 'Specifies whether to ignore certificate revocation errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'IgnoreCertificateAuthError' => ['description' => 'Specifies whether to ignore CA certificate authentication errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'IgnoreCertificateOutOfDateError' => ['description' => 'Specifies whether to ignore certificate invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'IgnoreCertificateUsingError' => ['description' => 'Specifies whether to ignore certificate usage errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'VerifyWay' => ['description' => 'The verification method. Valid values:'."\n" + ."\n" + .'* 0: no verification'."\n" + .'* 1: string verification'."\n" + .'* 2: MD5 verification'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'ValidateKeywords' => ['description' => 'The keyword that is used in verification.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], + 'WhiteList' => ['description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Stream' => [ + 'description' => 'The parameters of the streaming-media synthetic test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The resource URL of the streaming media.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com/stream/test.mp4'."\n", 'title' => ''], + 'StreamType' => ['description' => 'Specifies whether the resource is a video or audio. Valid values: 0: video. 1: audio.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'StreamMonitorTimeout' => ['description' => 'The monitoring duration. Unit: seconds. Maximum and default value: 60.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'StreamAddressType' => ['description' => 'The address type of the resource. Valid values:'."\n" + ."\n" + .'* 1: resource URL'."\n" + .'* 0 (default): page URL'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'PlayerType' => ['description' => 'The player. Default value: 12. Valid values:'."\n" + ."\n" + .'* 12: VLC'."\n" + .'* 2: Flash Player'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '12', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The custom header. Format: JSON map.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}'."\n", 'description' => 'The custom header. Format: JSON map.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], + 'WhiteList' => ['description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => true, + 'example' => '', ], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"1683353594000\\",\\n \\"Name\\": \\"tomcat-demo-test\\",\\n \\"Pid\\": \\"avccccefy0@24cccccbf384dc6\\",\\n \\"Type\\": \\"RUM\\",\\n \\"NickName\\": \\"nickname\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppType\\": \\"web\\",\\n \\"Status\\": \\"running\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\",\\n \\"IsSubscription\\": \\"true\\",\\n \\"Description\\": \\"门户首页。\\",\\n \\"PackageName\\": \\"com.alibaba.rum\\",\\n \\"Endpoint\\": \\"xxxxxxxx-default-cn.rum.aliyuncs.com\\",\\n \\"SlsProject\\": \\"proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Label\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ],\\n \\"SlsLogstore\\": \\"logstore-rum\\",\\n \\"ServiceDomainConfigs\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"Description\\": \\"测试\\",\\n \\"Tracing\\": true,\\n \\"PropagatorTypes\\": [\\n \\"sw8\\"\\n ],\\n \\"SamplingRate\\": 100\\n }\\n ],\\n \\"CdnDomain\\": \\"b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js\\",\\n \\"BonreeSDKConfig\\": {\\n \\"moduleConfig\\": {\\n \\"enable\\": true,\\n \\"defaultConfig\\": {\\n \\"key\\": {\\n \\"enable\\": true\\n }\\n },\\n \\"versionConfigs\\": {\\n \\"key\\": {\\n \\"useCustom\\": true,\\n \\"customConfig\\": {\\n \\"key\\": {\\n \\"enable\\": true\\n }\\n },\\n \\"description\\": \\"1.1.0版本配置\\",\\n \\"updateTime\\": 1721112372055\\n }\\n }\\n },\\n \\"samplingConfig\\": {\\n \\"samplingType\\": 1,\\n \\"samplingRate\\": 500\\n }\\n },\\n \\"AppGroup\\": \\"default\\",\\n \\"BackendServiceTraceRegion\\": \\"cn-hangzhou\\",\\n \\"AppConfig\\": \\"{\\\\\\"apiRequestOfH5\\\\\\":300,\\\\\\"apiRequestOfOriginal\\\\\\":500,\\\\\\"coldStart\\\\\\":5000,\\\\\\"hotStart\\\\\\":3000,\\\\\\"staticResourceLoad\\\\\\":300,\\\\\\"stutter\\\\\\":1000,\\\\\\"viewLoadOfH5\\\\\\":1000,\\\\\\"viewLoadOfOriginal\\\\\\":2000}\\",\\n \\"WebSDKConfigJson\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetRumAppInfo', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'GetRumApps' => [ - 'summary' => 'Queries a list of Real User Monitoring (RUM) applications.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194710', - 'abilityTreeNodes' => [ - 'FEATUREarmsRY7LT8', + 'name' => 'MonitorCategory', + 'in' => 'query', + 'schema' => ['description' => 'The detection point type. Valid values:'."\n" + ."\n" + .'- 1: PC'."\n" + .'- 2: mobile device', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'Monitors', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'b590lhguqs@28f515462******', + 'description' => 'The list of detection points.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CityCode' => ['description' => 'The city code.', 'type' => 'string', 'required' => true, 'example' => '100023', 'title' => ''], + 'OperatorCode' => ['description' => 'The carrier code.', 'type' => 'string', 'required' => true, 'example' => '1', 'title' => ''], + 'ClientType' => ['description' => 'The client type of the detection point. Valid values:'."\n" + ."\n" + .'- 1: data center'."\n" + .'- 2: Internet'."\n" + .'- 3: mobile device'."\n" + .'- 4: ECS instance', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AppGroup', + 'name' => 'Frequency', + 'in' => 'query', + 'schema' => ['description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.', 'type' => 'string', 'required' => true, 'example' => '5m', 'title' => ''], + ], + [ + 'name' => 'CustomPeriod', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The group to which the application belongs.'."\n", - 'type' => 'string', + 'description' => 'The general settings.', + 'type' => 'object', + 'properties' => [ + 'EndHour' => ['description' => 'The custom host settings.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '22', 'title' => ''], + 'StartHour' => ['description' => 'The list of hosts.', 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '8', 'title' => ''], + ], 'required' => false, - 'example' => 'default', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AppName', + 'name' => 'CommonSetting', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the application. You can specify only one application name in each request.'."\n", - 'type' => 'string', + 'description' => 'The general settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'The list of hosts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'required' => true, 'example' => 'www.aliyun.com', 'title' => ''], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4.'."\n" + .'* 2: IPv6.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + 'Ips' => [ + 'description' => 'The list of IP addresses.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'required' => true, 'example' => '10.176.141.63', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', + ], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], + 'SelectType' => ['description' => 'The selection mode. Valid values:'."\n" + ."\n" + .'* 0: random'."\n" + .'* 1: polling'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4.'."\n" + .'* 2: IPv6.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'MonitorSamples' => ['description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IsOpenTrace' => ['description' => 'Specifies whether to enable tracing.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TraceClientType' => ['description' => 'The type of the client for tracing. Valid values:'."\n" + ."\n" + .'* 0: ARMS agent'."\n" + .'* 1: OpenTelemetry'."\n" + .'* 2: Jaeger'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'XtraceRegion' => ['description' => 'The region to which trace data is reported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'CustomVPCSetting' => [ + 'description' => 'The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'VpcId' => ['description' => 'VPC ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp1muectbr8f90vjxxxxx', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-bp14crq29vpycxp8xxxxx', 'title' => ''], + 'SecureGroupId' => ['description' => 'The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-bp13wzf9vuwegmpxxxxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CustomPrometheusSetting' => [ + 'description' => 'The reserved parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'A reserved parameter.'."\n", 'example' => '保留字段。', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PrometheusClusterId' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '保留字段。', 'title' => ''], + 'PrometheusClusterRegion' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '保留字段。', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'example' => 'test-app', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AppType', + 'name' => 'AvailableAssertions', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The application type. Currently, supported application types include: web, mini program, Android, iOS, Windows, macOS, and HarmonyOS.'."\n", - 'type' => 'string', + 'description' => 'The list of assertions.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.', 'type' => 'string', 'required' => true, 'example' => 'DnsARecord', 'title' => ''], + 'Target' => ['description' => 'The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.', 'type' => 'string', 'required' => false, 'example' => 'key', 'title' => ''], + 'Operator' => ['description' => 'The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.', 'type' => 'string', 'required' => true, 'example' => 'eq', 'title' => ''], + 'Expect' => ['description' => 'The expected value.', 'type' => 'string', 'required' => true, 'example' => '200', 'title' => ''], + ], + 'required' => true, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'web', + 'title' => '', + 'example' => '', ], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The tag list.', 'type' => 'array', 'items' => [ - 'description' => 'The tags.'."\n", + 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'Key', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => '500', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], ], @@ -9065,199 +6898,109 @@ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '70675725-8F11-4817-8106-CFE0AD71****', - ], - 'Code' => [ - 'description' => 'The response code. 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', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'Internal error, please contact customer service.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'AppList' => [ - 'description' => 'The queried applications.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The application details.'."\n", - 'type' => 'object', - 'properties' => [ - 'CreateTime' => [ - 'description' => 'The time when the application was created. The value is a timestamp.'."\n", - 'type' => 'any', - 'example' => '1685686960872', - ], - 'Name' => [ - 'description' => 'The application name.'."\n", - 'type' => 'string', - 'example' => 'home page', - ], - 'Pid' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'example' => 'xxxxx@cc08bdxxxx20b15', - ], - 'Type' => [ - 'description' => 'The type of the application. Valid value: RUM.'."\n", - 'type' => 'string', - 'example' => 'RUM', - ], - 'NickName' => [ - 'description' => 'The alias of the application.'."\n", - 'type' => 'string', - 'example' => 'Williamtag', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AppType' => [ - 'description' => 'The application type. Valid values: web, miniapp, ios, and android.'."\n", - 'type' => 'string', - 'example' => 'web', - ], - 'Status' => [ - 'description' => 'The status of the application. Valid values: created, running, and stopped.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmzaq3ypaqkdy', - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.'."\n", - 'type' => 'string', - 'example' => 'tag1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - ], - ], - ], - 'IsSubscription' => [ - 'description' => 'Indicates whether the application is subscribed. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Description' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'example' => 'TEST', - ], - 'PackageName' => [ - 'description' => 'The package name of the Android application.'."\n", - 'type' => 'string', - 'example' => 'com.zy.yxws', - ], - 'Endpoint' => [ - 'description' => 'The endpoint that is used to report application data.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', - ], - 'SlsProject' => [ - 'description' => 'The name of the Simple Log Service project that stores application data.'."\n", - 'type' => 'string', - 'example' => 'proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou', - ], - 'SlsLogstore' => [ - 'description' => 'The name of the Simple Log Service Logstore that stores application data.'."\n", - 'type' => 'string', - 'example' => 'logstore-rum', - ], - 'ServiceDomainConfigs' => [ - 'description' => 'The list of service domain configurations. Only mobile applications are supported.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The service domain configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name or IP address.'."\n", - 'type' => 'string', - 'example' => 'example.com', - ], - 'Description' => [ - 'description' => 'The description.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'Tracing' => [ - 'description' => 'Indicates whether the tracing analysis feature is enabled. To enable the tracing analysis feature, you must activate Managed Service for OpenTelemetry. Valid values:'."\n" - ."\n" - .'* `true`: enables the tracing analysis feature. If you enable the tracing analysis feature, related headers are inserted into requests for the domain name.'."\n" - .'* `false`: disables the tracing analysis feature.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'PropagatorTypes' => [ - 'description' => 'The trace propagation protocols. This parameter is required if the tracing analysis feature is enabled.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The trace propagation protocol. Valid values: sw6 and sw8. sw6 indicates SkyWalking V2 and sw8 indicates SkyWalking V3.'."\n", - 'type' => 'string', - 'example' => 'sw8', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '53B5874D-EBC1-5567-B787-E4B7267F5CEB'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code returned. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The struct returned.', + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the synthetic monitoring task.', 'type' => 'string', 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', 'title' => ''], + 'Status' => ['description' => 'The task status. Valid values:'."\n" + ."\n" + .'- INIT: The task is in the initial state.'."\n" + .'- RELEASE: The task is being parsed.'."\n" + .'- RUNNING: The task is running.'."\n" + .'- STOP: The task is suspended.'."\n" + .'- SYSTEM_STOP: The task is suspended by the system.'."\n" + .'- CANCEL: The task is canceled.'."\n" + .'- SYSTEM_CANCEL: The task is canceled by the system.'."\n" + .'- DONE: The task is complete.', 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系客服。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AppList\\": [\\n {\\n \\"CreateTime\\": \\"1685686960872\\",\\n \\"Name\\": \\"门户首页。\\",\\n \\"Pid\\": \\"xxxxx@cc08bdxxxx20b15\\",\\n \\"Type\\": \\"RUM\\",\\n \\"NickName\\": \\"Williamtag\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppType\\": \\"web\\",\\n \\"Status\\": \\"running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzaq3ypaqkdy\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"ok\\"\\n }\\n ],\\n \\"IsSubscription\\": true,\\n \\"Description\\": \\"测试\\",\\n \\"PackageName\\": \\"com.zy.yxws\\",\\n \\"Endpoint\\": \\"xxxxxxxx-default-cn.rum.aliyuncs.com\\",\\n \\"SlsProject\\": \\"proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou\\",\\n \\"SlsLogstore\\": \\"logstore-rum\\",\\n \\"ServiceDomainConfigs\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"Description\\": \\"测试\\",\\n \\"Tracing\\": \\"true\\",\\n \\"PropagatorTypes\\": [\\n \\"sw8\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetRumApps', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'CreateRumApp' => [ - 'summary' => 'Create a Real User Monitoring (RUM) application.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ['errorCode' => 'INNER_PROHIBIT', 'errorMessage' => '内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53B5874D-EBC1-5567-B787-E4B7267F5CEB\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"5308a2691f59422c8c3b7aeccec9cd3b\\",\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]', + 'title' => 'CreateTimingSyntheticTask', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'requestParamsDescription' => 'Assertion description:'."\n" + ."\n" + .'### HTTP synthetic tests'."\n" + ."\n" + .'If the type parameter is set to HttpResCode, the Operator parameter supports the following values: eq, neq, gt, gte, lt, lte, belong, and n_belong.'."\n" + .'If the type parameter is set to HttpResHead, the Operator parameter supports all values.'."\n" + .'If the type parameter is set to HttpResBody, the Operator parameter supports all values.'."\n" + .'If the type parameter is set to HttpResBodyJson, the Operator parameter supports all values.'."\n" + .'If the type parameter is set to HttpResponseTime, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + ."\n" + .'### ICMP synthetic tests'."\n" + ."\n" + .'If the type parameter is set to IcmpPackLoss, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to IcmpPackMaxLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to IcmpPackAvgLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to TraceRouteHops, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'### DNS synthetic tests'."\n" + ."\n" + .'If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.'."\n" + .'If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.'."\n" + .'### Website speed measurement'."\n" + ."\n" + .'If the type parameter is set to websiteTTFB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to websiteTTLB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to websiteFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to websiteFFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" + .'If the type parameter is set to websiteOnload, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.', + 'changeSet' => [ + ['createdAt' => '2024-04-12T06:35:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-14T12:26:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-01T02:14:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-23T06:20:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-26T12:34:24.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-09-08T02:00:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTimingSyntheticTask'], + ], ], + 'ramActions' => [], + ], + 'CreateWebhook' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9265,356 +7008,207 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194698', - 'abilityTreeNodes' => [ - 'FEATUREarmsRY7LT8', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'AppName', + 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'The application name.', - 'type' => 'string', - 'required' => true, - 'example' => 'test-app', - ], + 'schema' => ['description' => 'The name of the contact.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Webhook告警', 'title' => ''], ], [ - 'name' => 'SiteType', + 'name' => 'Method', 'in' => 'query', - 'schema' => [ - 'description' => 'The application type. Valid values: web, miniapp, ios, and android.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'web', - ], + 'schema' => ['description' => 'The HTTP request method.'."\n" + ."\n" + .'* `Get`'."\n" + .'* `Post`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'Post', 'title' => ''], ], [ - 'name' => 'Source', + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'The source. This is a reserved parameter.', - 'type' => 'string', - 'required' => false, - 'example' => 'arms', - ], + 'schema' => ['description' => 'The URL of the request **method**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******', 'title' => ''], ], [ - 'name' => 'AppGroup', + 'name' => 'HttpParams', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the application group.', - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['description' => 'The parameters in the HTTP request.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"name":"mike"}]', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'HttpHeaders', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the application.', - 'type' => 'string', - 'required' => false, - 'example' => 'Monitoring description', - ], + 'schema' => ['description' => 'The HTTP request header.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Content-Type":"application/json"}]', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Tag', + 'name' => 'Body', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of tags. You can specify a maximum of 20 tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'app', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ecs', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The notification template that is sent when an alert is triggered. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "告警时间":"{{ .startTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }', 'title' => ''], ], [ - 'name' => 'PackageName', + 'name' => 'RecoverBody', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Android application package. This parameter is required if you create an Android application.', - 'type' => 'string', - 'required' => false, - 'example' => 'com.xxxx.xxxxxx', - ], + 'schema' => ['description' => 'The notification template that is sent when an alert is resolved. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "恢复时间":"{{ .endTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }', 'title' => ''], ], - [ - 'name' => 'RegionId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['description' => 'The ID of the contact for webhook alerts.'."\n", 'type' => 'string', 'example' => '48716', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ContactId\\": \\"48716\\",\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateWebhookResponse>\\n <ContactId>48716</ContactId>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n</CreateWebhookResponse>","errorExample":""}]', + 'title' => 'CreateWebhook', + 'summary' => 'Adds a contact for webhook alerts.', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateWebhookContact接口创建或修改Webhook告警联系人。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2021-10-28T08:06:55.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-10-28T08:06:55.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DelAuthToken' => [ + 'summary' => 'Disables an authentication token.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'NickName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The nickname of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test-app', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'RealRegionId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-finance-1', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language used by the client.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'java', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'title' => 'Id of the request', - 'description' => 'The error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The application ID and domain names. This parameter is returned if the application is created. Multiple domain names are separated with commas (,).'."\n", - 'type' => 'object', - 'properties' => [ - 'Pid' => [ - 'description' => 'The process ID (PID) of the application.'."\n", - 'type' => 'string', - 'example' => 'avccccxxxx@24cxxxxbf384dc6', - ], - 'Endpoint' => [ - 'description' => 'The endpoint that is used to report application data.'."\n", - 'type' => 'string', - 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', - ], - 'CdnDomain' => [ - 'description' => 'The domain name of the SDK.'."\n", - 'type' => 'string', - 'example' => 'bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js', - ], - ], - 'example' => 'ggxxxnjuz@xxxx,xxxxxx-default-cn.rum.aliyuncs.com', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.', - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], + 'Data' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"应用已存在。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": {\\n \\"Pid\\": \\"avccccxxxx@24cxxxxbf384dc6\\",\\n \\"Endpoint\\": \\"xxxxxxxx-default-cn.rum.aliyuncs.com\\",\\n \\"CdnDomain\\": \\"bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js\\"\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n}","type":"json"}]', - 'title' => 'CreateRumApp', - ], - 'DeleteRumApp' => [ - 'summary' => 'Deletes a RUM application.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DelAuthToken', + 'changeSet' => [ + ['createdAt' => '2022-06-10T08:29:55.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DelAuthToken'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\"\\n}","type":"json"}]', + ], + 'DeleteAddonRelease' => [ + 'summary' => 'Delete AddonRelease data by AddonRelease name.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AppId', + 'name' => 'ReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b590lhguqs@28f515462******', - ], + 'schema' => ['title' => '', 'description' => 'Name of Release.', 'type' => 'string', 'required' => true, 'example' => 'agent-822567d4-2449'], ], [ - 'name' => 'AppGroup', + 'name' => 'Force', 'in' => 'query', - 'schema' => [ - 'description' => 'The group where the application resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], + 'schema' => ['title' => '', 'description' => 'Whether to be forcibly deleted. The default value is false.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RealRegionId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shanghai-finance-1', - ], + 'schema' => ['title' => '', 'description' => 'Environment ID.', 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the add-on. If you assign a value to AddonName, the ReleaseName parameter is ignored and all AddonReleases that belong to the same add-on are deleted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request is successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Result' => [ - 'description' => 'The message that appears when the application is deleted.'."\n", - 'type' => 'string', - 'example' => 'Success to delete app.', - ], - 'ResourceGroupId' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2eq4peca****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****'], + 'Code' => ['description' => 'Status code: 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" + ."\n" + .'* `true`: The alert rule was deleted.'."\n" + .'* `false`: The alert rule failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'Return a message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"删除的应用不存在。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Result\\": \\"删除应用成功。\\",\\n \\"ResourceGroupId\\": \\"rg-aek2eq4peca****\\"\\n}","type":"json"}]', - 'title' => 'DeleteRumApp', - ], - 'UpdateRumApp' => [ - 'summary' => 'Updates a Real User Monitoring (RUM) application.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteAddonRelease', + 'changeSet' => [ + ['createdAt' => '2024-06-07T08:50:37.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ], ], + 'ramActions' => [], + ], + 'DeleteAlertContact' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -9623,150 +7217,247 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '211832', - 'abilityTreeNodes' => [ - 'FEATUREarmsRY7LT8', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '44436', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'b5xxxxs@d8deedfa9bf****', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'ContactId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can query logs and troubleshoot issues based on the ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertContactResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n</DeleteAlertContactResponse>","errorExample":""}]', + 'title' => 'DeleteAlertContact', + 'summary' => 'Deletes an DeleteAlertContact contact.', + 'description' => '********', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-14T01:30:43.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DeleteAlertContactGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'IsSubscribe', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether you want to subscribe to the application. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Nickname', + 'name' => 'ContactGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The alias of the application.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Android Test', - ], + 'schema' => ['description' => 'The ID of the alert contact group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], ], - [ - 'name' => 'Restart', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to restart the application. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertContactGroupResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n</DeleteAlertContactGroupResponse>","errorExample":""}]', + 'title' => 'DeleteAlertContactGroup', + 'summary' => 'Deletes an DeleteAlertContactGroup contact group.', + 'description' => '当前接口已不再维护，请使用新版告警管理的DeleteContactGroup接口删除告警联系人组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-14T01:30:42.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'DeleteAlertRule' => [ + 'summary' => 'Deletes an alert rule.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Stop', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to stop the application. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AutoRestart', + 'name' => 'AlertId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The alert rule ID.'."\n" + ."\n" + .'For more information about how to obtain the ID of an alert rule, see [GetAlertRules](~~2612348~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether to restart the application the next day. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'IsSuccess' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertRuleResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteAlertRuleResponse>","errorExample":""}]', + 'title' => 'DeleteAlertRule', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:20:29.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlertRule'], + ], + ], + 'ramActions' => [], + ], + 'DeleteAlertRules' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ServiceDomainOperationJson', - 'in' => 'query', - 'schema' => [ - 'description' => 'The service domain name of the application. You can create, modify, and delete service domain name configurations.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"Op\\":\\"Update\\",\\"Domain\\":\\"example.com\\",\\"Config\\":{\\"Description\\":\\"message\\",\\"Tracing\\":\\"true\\",\\"PropagatorTypes\\":[\\"sw8\\"]}}', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'BonreeSDKConfigJson', + 'name' => 'AlertIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The collection configurations of the mobile SDK. You can enable or disable collection configurations based on the app version.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"moduleConfig\\":{\\"enable\\":true,\\"defaultConfig\\":{\\"network\\":{\\"enable\\":true},\\"h5\\":{\\"enable\\":true},\\"routechange\\":{\\"enable\\":true},\\"crash\\":{\\"enable\\":true},\\"view\\":{\\"enable\\":true},\\"coollaunch\\":{\\"enable\\":true},\\"hotlaunch\\":{\\"enable\\":true},\\"action\\":{\\"enable\\":true},\\"lagstuck\\":{\\"enable\\":true},\\"lagfps\\":{\\"enable\\":true},\\"statechange\\":{\\"enable\\":true},\\"anr\\":{\\"enable\\":true},\\"customlog\\":{\\"enable\\":true},\\"customevent\\":{\\"enable\\":true},\\"custommetric\\":{\\"enable\\":true}},\\"versionConfigs\\":{\\"1.1.0\\":{\\"useCustom\\":true,\\"customConfig\\":{\\"network\\":{\\"enable\\":true},\\"h5\\":{\\"enable\\":true},\\"routechange\\":{\\"enable\\":true},\\"crash\\":{\\"enable\\":true},\\"view\\":{\\"enable\\":true},\\"coollaunch\\":{\\"enable\\":true},\\"hotlaunch\\":{\\"enable\\":true},\\"action\\":{\\"enable\\":true},\\"lagstuck\\":{\\"enable\\":false},\\"lagfps\\":{\\"enable\\":false},\\"statechange\\":{\\"enable\\":true},\\"anr\\":{\\"enable\\":true},\\"customlog\\":{\\"enable\\":true},\\"customevent\\":{\\"enable\\":true},\\"custommetric\\":{\\"enable\\":true}}},\\"1.2.0\\":{\\"useCustom\\":false,\\"customConfig\\":{}}}}}', - ], + 'schema' => ['description' => 'The IDs of the alert rules that you want to delete. The value is a JSON array, for example, `[123, 234]`. You can call the SearchAlertRules operation and view the `Id` parameter in the response to obtain the alert rule ID. For more information, see [SearchAlertRules](~~175825~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[123, 234]', 'title' => ''], ], [ - 'name' => 'RealRegionId', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => ['description' => 'Indicates whether the alert rule was deleted.'."\n" + ."\n" + .'* `true`: The alert rule was deleted.'."\n" + .'* `false`: The alert rule failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertRulesResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n</DeleteAlertRulesResponse>","errorExample":""}]', + 'title' => 'DeleteAlertRules', + 'summary' => 'Deletes alert rules.', + 'description' => 'The current operation is no longer maintained. Call the DeleteAlertRule operation of Alert Management (New) to delete alert rules.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-22T02:31:49.000Z', 'description' => 'Error codes changed'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlertRules'], + ], + ], + ], + 'DeleteAppList' => [ + 'summary' => 'Deletes multiple applications at a time based on the process IDs (PIDs).', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], + 'security' => [ [ - 'name' => 'BackendServiceTraceRegion', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region where the backend application is deployed. This parameter is used in end-to-end tracing scenarios.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"moduleConfig\\":{\\"enable\\":true,\\"defaultConfig\\":{\\"network\\":{\\"enable\\":true},\\"h5\\":{\\"enable\\":true},\\"routechange\\":{\\"enable\\":true},\\"crash\\":{\\"enable\\":true},\\"view\\":{\\"enable\\":true},\\"coollaunch\\":{\\"enable\\":true},\\"hotlaunch\\":{\\"enable\\":true},\\"action\\":{\\"enable\\":true},\\"lagstuck\\":{\\"enable\\":true},\\"lagfps\\":{\\"enable\\":true},\\"statechange\\":{\\"enable\\":true},\\"anr\\":{\\"enable\\":true},\\"customlog\\":{\\"enable\\":true},\\"customevent\\":{\\"enable\\":true},\\"custommetric\\":{\\"enable\\":true}},\\"versionConfigs\\":{\\"1.1.0\\":{\\"useCustom\\":true,\\"customConfig\\":{\\"network\\":{\\"enable\\":true},\\"h5\\":{\\"enable\\":true},\\"routechange\\":{\\"enable\\":true},\\"crash\\":{\\"enable\\":true},\\"view\\":{\\"enable\\":true},\\"coollaunch\\":{\\"enable\\":true},\\"hotlaunch\\":{\\"enable\\":true},\\"action\\":{\\"enable\\":true},\\"lagstuck\\":{\\"enable\\":false},\\"lagfps\\":{\\"enable\\":false},\\"statechange\\":{\\"enable\\":true},\\"anr\\":{\\"enable\\":true},\\"customlog\\":{\\"enable\\":true},\\"customevent\\":{\\"enable\\":true},\\"custommetric\\":{\\"enable\\":true}}},\\"1.2.0\\":{\\"useCustom\\":false,\\"customConfig\\":{}}}}}', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'AppConfig', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application configurations in the JSON format. This parameter is deprecated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'WebSDKConfigJson', + 'name' => 'Pids', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'description' => 'The list of PIDs for the applications monitored by Application Monitoring.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The PID of an application.'."\n", 'type' => 'string', 'required' => false, 'example' => '["atc889zkcf@d8deedfa9bfxxxx", "acd129bfcf@d5daebfa6cdxxxx"]', 'title' => ''], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 800, + 'title' => '', + 'example' => '', ], ], ], @@ -9777,194 +7468,162 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The details of the returned results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Config' => [ - 'description' => 'The user configurations. This is a reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Usage' => [ - 'description' => 'The usage. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10000', - ], - 'Limit' => [ - 'description' => 'The QPS limit. Unit: bytes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100000', - ], - 'Limited' => [ - 'description' => 'Indicates whether the request is throttled due to the QPS limit. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4B446DF2-3DDD-4B5B-8E3F-D5225120****'], + 'Data' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '"{\\"code\\":200,\\"data\\":\\"{\\\\\\"code\\\\\\":200,\\\\\\"data\\\\\\":true,\\\\\\"errorCode\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"message\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"success\\\\\\":true,\\\\\\"traceId\\\\\\":\\\\\\"0bc1667516940677164677396d0088\\\\\\"}\\",\\"errorCode\\":\\"批量删除应用成功\\",\\"message\\":\\"批量删除应用成功\\",\\"success\\":true,\\"traceId\\":\\"210f470416940677161213505e0e7a\\"}"', 'title' => ''], + 'Message' => ['description' => 'The error message returned for invalid request parameters.'."\n", 'type' => 'string', 'example' => '“批量删除应用成功”', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the specified applications are deleted. Valid values:'."\n" + ."\n" + .'* `true`: The applications are deleted.'."\n" + .'* `false`: The applications failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterUserIdIsNull', 'errorMessage' => 'User ID is null.', 'description' => ''], + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => ''], + ['errorCode' => 'ParameterResourceIdIsNull', 'errorMessage' => 'Resource ID is null.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"message\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Config\\": \\"用户配置，保留字段。\\",\\n \\"Usage\\": 10000,\\n \\"Limit\\": 100000,\\n \\"Limited\\": true\\n }\\n}","type":"json"}]', - 'title' => 'UpdateRumApp', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'GetRumExceptionStack' => [ - 'summary' => 'Queries the exception stack information of a Real User Monitoring (RUM) application.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B446DF2-3DDD-4B5B-8E3F-D5225120****\\",\\n \\"Data\\": \\"\\\\\\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"0bc1667516940677164677396d0088\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"批量删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"批量删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"210f470416940677161213505e0e7a\\\\\\\\\\\\\\"}\\\\\\"\\",\\n \\"Message\\": \\"“批量删除应用成功”\\",\\n \\"Success\\": true,\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => 'DeleteAppList', + 'changeSet' => [ + ['createdAt' => '2024-03-26T07:31:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-07T02:51:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteCmsExporter' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '213079', - 'abilityTreeNodes' => [ - 'FEATUREarms46ES94', - ], - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Pid', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The application ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'atxxxxzkcf@d8deedfa9bf****', - ], + 'schema' => ['description' => 'Region ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ExceptionStack', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The exception stack information. Set the value to a JSON string. call_stack.info represents the stack information, call_stack.thread.name represents the thread name, and call_stack.thread.id represents the thread ID. This parameter is exactly the same as the exception.stack parameter in the logstore-rum Logstore of Simple Log Service.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '['."\n" - .'{'."\n" - .' "call_stack.info": "libsystem_kernel.dylib 0x00000001f1ce9178 0x00000001f1ce8000 + 4472\\r\\nlibsystem_kernel.dylib 0x00000001f1ce8f10 0x00000001f1ce8000 + 3856\\r\\nlibsystem_kernel.dylib 0x00000001f1ced718 0x00000001f1ce8000 + 22296\\r\\nAlibabaCloudRUM 0x0000000106711af4 0x0000000106660000 + 727796\\r\\nlibsystem_pthread.dylib 0x00000002146744d4 0x0000000214672000 + 9428",'."\n" - .' "call_stack.thread.name": "#3 BRSCrash Exception Handler (Secondary)",'."\n" - .' "call_stack.thread.id": "16643"'."\n" - .' }'."\n" - .']', - ], + 'schema' => ['description' => 'Cluster ID. ', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], - [ - 'name' => 'ExceptionBinaryImages', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The binary images, which represent all executable files loaded into the process address space when a crash occurs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'iOSDemo:arm64%3B1489F4D3-6DE2-300C-90E9-E1B869675351%3B0x0000000104064000\\nAlibabaCloudRUM:arm64%3BAB7B3A8E-6CEE-325D-BCBB-8DA50E61804F%3B0x0000000106660000\\nlibdispatch.dylib:arm', + 'title' => 'Schema of Response', + 'description' => 'Response content. ', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The unique ID of this request. If a fault occurs, you can use this ID to troubleshoot the issue. ', 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****'], + 'Data' => ['description' => 'Return Result information. ', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'ExceptionThreadId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the exception thread.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '16643', - ], + ], + 'staticInfo' => [ + 'substitutions' => ['ARMS::2019-08-08::DeleteAddonRelease'], + ], + 'title' => 'Uninstall Prometheus for an Alibaba Cloud service instance ', + 'summary' => 'Uninstall Prometheus for an Alibaba Cloud service instance. ', + 'changeSet' => [ + ['createdAt' => '2022-04-22T09:39:44.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCmsExporter'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'DeleteContact' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'SourcemapType', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => 'The parsing type. Valid values:'."\n" - ."\n" - .'* js: Parses JavaScript errors.'."\n" - .'* sym: Parses PC errors.'."\n" - .'* har: Parses HarmonyOS errors.'."\n" - .'* dSYM: Parses iOS errors.'."\n" - .'* so: Parses Android errors.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'source-map', - ], + 'schema' => ['description' => 'The ID of the alert contact.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'title' => '', 'example' => '123'], ], - [ - 'name' => 'ExtraInfo', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Extra information about iOS symbol tables. You can leave this parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GraphicsServices:system/GraphicsServices/85419099-269B-336D-86B4-0D52D0FF6923/GraphicsServices;WebCore:system/WebCore/BF44A3F4-85D4-38C8-BF26-197F06ADE273/WebCore', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'IsSuccess' => ['description' => 'Indicates whether the alert contact is deleted. Valid values:'."\n" + ."\n" + .'- `true`: The alert contact is deleted.'."\n" + ."\n" + .'- `false`: The alert contact is not deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'title' => 'DeleteContact', + 'summary' => 'Deletes alert contacts.', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContact'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","type":"json"}]', + ], + 'DeleteContactGroup' => [ + 'summary' => 'Deletes an alert contact group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Workspace', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'ServiceId', + 'name' => 'ContactGroupId', 'in' => 'query', - 'schema' => [ - 'type' => 'string', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the alert contact group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], ], 'responses' => [ @@ -9974,406 +7633,172 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request.', - 'type' => 'string', - 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', - ], - 'Code' => [ - 'description' => 'The responses code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The response message.'."\n", - 'type' => 'object', - 'properties' => [ - 'ThreadId' => [ - 'description' => 'The thread ID.'."\n", - 'type' => 'string', - 'example' => '16643', - ], - 'Lines' => [ - 'description' => 'The list of stacks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The exception stack information that is parsed.'."\n", - 'type' => 'string', - 'example' => '"CoreFoundation 0x00000001aa66a678 0x00000001aa57e000 + 968312",'."\n" - .' "libobjc.A.dylib 0x00000001a2917c80 0x00000001a28ec000 + 179328"', - ], - ], - 'CrashReason' => [ - 'description' => 'The cause of the exception. This parameter is exposed during the parsing of PC errors.'."\n", - 'type' => 'string', - 'example' => 'EXC_BAD_ACCESS / KERN_INVALID_ADDRESS', - ], - 'CrashAddress' => [ - 'description' => 'The crash address. This parameter is exposed during the parsing of PC errors.'."\n", - 'type' => 'string', - 'example' => '0x1', - ], - 'ThreadInfoList' => [ - 'description' => 'The thread stack information captured during PC crashes.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ThreadTag' => [ - 'description' => 'The thread tag, including the thread number and name.'."\n", - 'type' => 'string', - 'example' => 'Thread 0 (crashed)', - ], - 'ThreadDetail' => [ - 'description' => 'Thread stack details.'."\n", - 'type' => 'string', - 'example' => ' "0 libsystem_platform.dylib + 0x1ab5\\n rax = 0x0000000000000001 rdx = 0x0000000000000064\\n rcx = 0xffffffffffffffff rbx = 0x0000000107701bd0\\n rsi = 0x0101010101010101 rdi = 0x0000000000000001\\n rbp = 0x00007ff7b8d64300 rsp = 0x00007ff7b8d64300\\n r8 = 0x000000000000000a r9 = 0x0000000000000000\\n r10 = 0x0000000000000001 r11 = 0x0000000000000247\\n r12 = 0x00007ff7b8d64390 r13 = 0x0000000000000000\\n r14 = 0x000000010719d770 r15 = 0x00007ff7b8d64500\\n rip = 0x00007ff807a40ab5\\n Found by: given as instruction pointer in context\\n 1 alibabacloud_rum_example + 0x2ad1\\n rbp = 0x00007ff7b8d64310 rsp = 0x00007ff7b8d64310\\n rip = 0x000000010719dad1\\n Found by: previous frame\'s frame pointer\\n 2 alibabacloud_rum_example + 0x2a3b\\n rbp = 0x00007ff7b8d64360 rsp = 0x00007ff7b8d64320\\n rip = 0x000000010719da3b\\n Found by: previous frame\'s frame pointer\\n 3 0x7ff807688345\\n rbp = 0x00007ff7b8d64580 rsp = 0x00007ff7b8d64370\\n rip = 0x00007ff807688345\\n Found by: previous frame\'s frame pointer"'."\n", - ], - ], - 'description' => '', - ], - ], - 'ModuleName' => [ - 'description' => 'The name of the crash parsing module. This parameter is exposed during the parsing of PC errors.'."\n", - 'type' => 'string', - 'example' => 'alibabacloud_rum_example', - ], - 'Uuid' => [ - 'description' => 'The UUID of the symbol table required for parsing the stack. This parameter is exposed during the parsing of PC errors.'."\n", - 'type' => 'string', - 'example' => '9032259CEB9130E780C6DE8FDECCD7990', - ], - 'BinaryImages' => [ - 'description' => 'The name and UUID of the symbol table required for parsing the exception stack. This parameter is exposed during the parsing of PC errors.'."\n", - 'type' => 'string', - 'example' => '"04B5B216682E40BF9BBE9698E3F98CAA0,libcurl.4.dylib;7878DB3CF21A3C13A203B7E3B0FA66250,libalibabacloud_rum.dylib;0F9F96FE6B1C3253A33AC9E4A0C2A3860,libsystem_kernel.dylib;3DF3256F466E37BCB995A5A9956E14150,libsystem_pthread.dylib;000000000000000000000000000000000,Security;EA4B83A319EB3E15B22CDF035DBD49250,alibabacloud_rum_example;710BB12EEEC744BAB41D1849CA3AD8021,LTSDK.pdb;EE330BA9C49E4730AA15A2B7C0BB2CAE1,JBLive.pdb"', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'IsSuccess' => ['description' => 'Indicates whether the alert contact group was deleted. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B6A00968-82A8-4F14-9D1B-B53827DB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"ThreadId\\": \\"16643\\",\\n \\"Lines\\": [\\n \\"\\\\\\"CoreFoundation 0x00000001aa66a678 0x00000001aa57e000 + 968312\\\\\\",\\\\n \\\\\\"libobjc.A.dylib 0x00000001a2917c80 0x00000001a28ec000 + 179328\\\\\\"\\"\\n ],\\n \\"CrashReason\\": \\"EXC_BAD_ACCESS / KERN_INVALID_ADDRESS\\",\\n \\"CrashAddress\\": \\"0x1\\",\\n \\"ThreadInfoList\\": [\\n {\\n \\"ThreadTag\\": \\"Thread 0 (crashed)\\",\\n \\"ThreadDetail\\": \\" \\\\\\"0 libsystem_platform.dylib + 0x1ab5\\\\\\\\n rax = 0x0000000000000001 rdx = 0x0000000000000064\\\\\\\\n rcx = 0xffffffffffffffff rbx = 0x0000000107701bd0\\\\\\\\n rsi = 0x0101010101010101 rdi = 0x0000000000000001\\\\\\\\n rbp = 0x00007ff7b8d64300 rsp = 0x00007ff7b8d64300\\\\\\\\n r8 = 0x000000000000000a r9 = 0x0000000000000000\\\\\\\\n r10 = 0x0000000000000001 r11 = 0x0000000000000247\\\\\\\\n r12 = 0x00007ff7b8d64390 r13 = 0x0000000000000000\\\\\\\\n r14 = 0x000000010719d770 r15 = 0x00007ff7b8d64500\\\\\\\\n rip = 0x00007ff807a40ab5\\\\\\\\n Found by: given as instruction pointer in context\\\\\\\\n 1 alibabacloud_rum_example + 0x2ad1\\\\\\\\n rbp = 0x00007ff7b8d64310 rsp = 0x00007ff7b8d64310\\\\\\\\n rip = 0x000000010719dad1\\\\\\\\n Found by: previous frame\'s frame pointer\\\\\\\\n 2 alibabacloud_rum_example + 0x2a3b\\\\\\\\n rbp = 0x00007ff7b8d64360 rsp = 0x00007ff7b8d64320\\\\\\\\n rip = 0x000000010719da3b\\\\\\\\n Found by: previous frame\'s frame pointer\\\\\\\\n 3 0x7ff807688345\\\\\\\\n rbp = 0x00007ff7b8d64580 rsp = 0x00007ff7b8d64370\\\\\\\\n rip = 0x00007ff807688345\\\\\\\\n Found by: previous frame\'s frame pointer\\\\\\"\\\\n\\"\\n }\\n ],\\n \\"ModuleName\\": \\"alibabacloud_rum_example\\",\\n \\"Uuid\\": \\"9032259CEB9130E780C6DE8FDECCD7990\\",\\n \\"BinaryImages\\": \\"\\\\\\"04B5B216682E40BF9BBE9698E3F98CAA0,libcurl.4.dylib;7878DB3CF21A3C13A203B7E3B0FA66250,libalibabacloud_rum.dylib;0F9F96FE6B1C3253A33AC9E4A0C2A3860,libsystem_kernel.dylib;3DF3256F466E37BCB995A5A9956E14150,libsystem_pthread.dylib;000000000000000000000000000000000,Security;EA4B83A319EB3E15B22CDF035DBD49250,alibabacloud_rum_example;710BB12EEEC744BAB41D1849CA3AD8021,LTSDK.pdb;EE330BA9C49E4730AA15A2B7C0BB2CAE1,JBLive.pdb\\\\\\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetRumExceptionStack', - 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", - ], - 'DescribeEnvDropMetricsRule' => [ - 'summary' => 'Queries the list of discarded metrics of a specified environment instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactGroupResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteContactGroupResponse>","errorExample":""}]', + 'title' => 'DeleteContactGroup', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactGroup'], + ], ], + 'ramActions' => [], + ], + 'DeleteDispatchRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'none', + 'abilityTreeCode' => '44440', + 'abilityTreeNodes' => ['FEATUREarmsVBCGEE'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the dispatch policy.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'EnvironmentId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxxx', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'RuleName' => [ - 'title' => '废弃指标规则名', - 'description' => 'The name of the discarded metric rule.', - 'type' => 'string', - 'example' => 'ruleName1', - ], - 'DropMetrics' => [ - 'title' => '废弃指标列表。多个指标之间，以换行分隔。', - 'description' => 'The list of discarded metrics. Separate multiple metrics with line feeds.', - 'type' => 'string', - 'example' => 'kube_pod_created', - ], - ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"RuleName\\": \\"ruleName1\\",\\n \\"DropMetrics\\": \\"kube_pod_created\\"\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'DescribeEnvDropMetricsRule', - ], - 'UpdateEnvDropMetricsRule' => [ - 'summary' => 'Updates a discarded metric rule in the environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDispatchRuleResponse>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n <Success>true</Success>\\n</DeleteDispatchRuleResponse>","errorExample":""}]', + 'title' => 'DeleteDispatchRule', + 'summary' => 'Deletes the dispatch policy of a specified ID.', + 'description' => '当前接口已不再维护，请使用新版告警管理的DeleteNotificationPolicy接口删除指定ID的通知策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-21T08:17:48.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DeleteEnvCustomJob' => [ + 'summary' => 'Deletes a custom job for an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* zh (default)'."\n" - .'* en', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx', 'title' => ''], ], [ - 'name' => 'DropMetrics', - 'in' => 'formData', - 'schema' => [ - 'title' => '多个指标之间，以换行分隔', - 'description' => 'The metric to be discarded. Separate multiple metrics with line feeds.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'metric_1'."\n" - .'metric_2'."\n" - .'metric_3', - ], + 'name' => 'CustomJobName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the custom job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'job1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response schema.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', - ], - 'Code' => [ - 'description' => 'The status code. 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果', - 'description' => 'The returned data.', - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The error message returned if the call failed.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteEnvCustomJob', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvCustomJob'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UpdateEnvDropMetricsRule', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'AddTagToFlinkCluster' => [ - 'summary' => 'Attaches the workspace ID and workspace name tags to the Prometheus instance corresponding to a Flink workspace.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEnvPodMonitor' => [ + 'summary' => 'Deletes the PodMonitor of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'write', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'prometheus实例ID', - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c5defa51f******c92bd2ef5fb093269', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TargetUserId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the Flink workspace belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '198608******7619', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxxx', 'title' => ''], ], [ - 'name' => 'FlinkWorkSpaceId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Flink workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ab18f***93744d', - ], + 'schema' => ['title' => '', 'description' => 'The namespace where the PodMonitor is located.'."\n", 'type' => 'string', 'required' => true, 'example' => 'arms-prom'], ], [ - 'name' => 'FlinkWorkSpaceName', + 'name' => 'PodMonitorName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Flink workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'flink-demo', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The name of the PodMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms-admin-pm1', 'title' => ''], ], ], 'responses' => [ @@ -10383,300 +7808,173 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', - ], - '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. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'Indicates whether the business logic was executed. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'string', - 'example' => 'false', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteEnvPodMonitor', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvPodMonitor'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": \\"false\\"\\n}","type":"json"}]', - 'title' => 'AddTagToFlinkCluster', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'CreateEnvironment' => [ - 'summary' => 'Creates an environment instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEnvServiceMonitor' => [ + 'summary' => 'Deletes the ServiceMonitor of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Default value: zh.'."\n" - ."\n" - .'Valid values:'."\n" - .'* en: English'."\n" - .'* zh: Chinese', - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxxx', 'title' => ''], ], [ - 'name' => 'EnvironmentName', + 'name' => 'Namespace', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => '环境名称', - 'description' => 'The name of the environment.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'env1', - ], + 'schema' => ['title' => '', 'description' => 'The namespace where the ServiceMonitor is located.'."\n", 'type' => 'string', 'required' => true, 'example' => 'arms-prom'], ], [ - 'name' => 'EnvironmentType', + 'name' => 'ServiceMonitorName', 'in' => 'query', + 'schema' => ['description' => 'The name of the ServiceMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms-admin1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '环境类型：'."\n" - .'CS（容器服务）、ECS、Cloud（云服务）', - 'description' => 'The type of the environment. Valid values:'."\n" - ."\n" - .'* CS: Container Service'."\n" - .'* ECS: Elastic Compute Service'."\n" - .'* Cloud: cloud service'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'CS', - 'enum' => [ - 'CS', - 'ECS', - 'Cloud', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteEnvServiceMonitor', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvServiceMonitor'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'DeleteEnvironment' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EnvironmentSubType', - 'in' => 'query', - 'schema' => [ - 'title' => 'ECS、ACK、Cloud、One', - 'description' => 'The subtype of the environment. Valid values:'."\n" - ."\n" - .'* CS: Container Service for Kubernetes (ACK) or Distributed Cloud Container Platform for Kubernetes (ACK One)'."\n" - .'* ECS: ECS'."\n" - .'* Cloud: cloud service'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ECS' => 'ECS', - 'Cloud' => 'Cloud', - 'One' => 'One', - 'ACK' => 'ACK', - ], - 'example' => 'ECS, ACK, etc.'."\n", - 'enum' => [], - ], + 'AK' => [], ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'BindResourceId', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '环境绑定的资源实例ID。如果是Cloud（云服务），则填写RegionId。', - 'description' => 'The ID of the resource bound to the environment, such as the container ID or VPC ID. For a Cloud environment, specify the region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'c6e9dec475dca4a50a188411d8cbxxx', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ManagedType', + 'name' => 'EnvironmentId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '托管类型：'."\n" - .'- none： 非托管。ACK集群的默认值。'."\n" - .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" - .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', - 'description' => 'Specifies whether agents or exporters are managed. Valid values:'."\n" - ."\n" - .'* none: No. By default, no managed agents or exporters are provided for ACK clusters.'."\n" - .'* agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters.'."\n" - .'* agent-exporter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'none', - 'enum' => [ - 'none', - 'agent', - 'agent-exporter', - ], - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxxx', 'title' => ''], ], [ - 'name' => 'FeePackage', + 'name' => 'DeletePromInstance', 'in' => 'query', 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Specifies whether to delete the related Prometheus instance.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '付费套餐。'."\n" - .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" - .'* EnvironmentType为其它值时，请输入空值。', - 'description' => 'The payable resource plan.'."\n" - ."\n" - .'* If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro. Default value: CS_Basic.'."\n" - .'* Otherwise, leave the parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'CS_Basic', - 'enum' => [ - 'CS_Basic', - 'CS_Pro', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], - [ - 'name' => 'PrometheusInstanceId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '可空，环境绑定的prom实例id。如果未提供，请调用 InitEnvironment 接口完成存储实例的初始化。', - 'description' => 'The ID of the Prometheus instance. If no Prometheus instance is created, call the InitEnvironment operation.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'c6e9dec475dca4a50a188411d8cbxxx', - 'enum' => [], - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DeleteEnvironment', + 'summary' => 'Deletes an environment instance.', + 'changeSet' => [ + ['createdAt' => '2023-11-13T02:04:19.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvironment'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'DeleteEnvironmentFeature' => [ + 'summary' => 'Deletes a feature.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GrafanaWorkspaceId', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '环境绑定的grafana工作区id。传空时，表示使用默认的共享grafana。', - 'description' => 'The ID of the Grafana workspace associated with the environment. If this parameter is left empty, the default shared Grafana workspace is used.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'grafana-rnglkcdrntlhk0****', - 'enum' => [], - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '资源组Id', - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rg-acfmxyexli2****', - 'enum' => [], - ], + 'schema' => ['title' => '', 'description' => 'The ID of the environment.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], [ - 'name' => 'Tags', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '可以传此参数，给实例创建标签进行管理', - 'description' => 'The tags of the instance. You can specify this parameter to manage tags for the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签名', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['title' => '', 'description' => 'The region ID. Valid values: cn-beijing and cn-hangzhou.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'InitEnvironment', + 'name' => 'FeatureName', 'in' => 'query', - 'schema' => [ - 'title' => '是否初始化环境', - 'description' => 'Specifies whether to initialize the environment.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['title' => '', 'description' => 'The feature name. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check.'."\n", 'type' => 'string', 'required' => true, 'example' => 'metric-agent'], ], ], 'responses' => [ @@ -10686,49 +7984,31 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '返回成功增加的环境Id。', - 'description' => 'The ID of the created environment.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteEnvironmentFeature', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvironmentFeature'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"env-xxxxx\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'CreateEnvironment', + 'ramActions' => [], ], - 'InitEnvironment' => [ - 'summary' => 'Initializes an environment instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteEventBridgeIntegration' => [ + 'summary' => 'Deletes an EventBridge integration that is used to push notifications.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -10737,459 +8017,201 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'none', + 'abilityTreeCode' => '133880', + 'abilityTreeNodes' => ['FEATUREarmsR0R9WE'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', + 'name' => 'Id', + 'in' => 'formData', + 'schema' => ['description' => 'Required. The ID of the EventBridge notification integration. You can call the **ListEventBridgeIntegrations** operation to query the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2B289756-E791-5842-BCBD-AD414C******'], + 'IsSuccess' => ['description' => 'Indicates whether the EventBridge integration is deleted.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B289756-E791-5842-BCBD-AD414C******\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteEventBridgeIntegrationResponse>\\n <RequestId>2B289756-E791-5842-BCBD-AD414C******</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteEventBridgeIntegrationResponse>","errorExample":""}]', + 'title' => 'DeleteEventBridgeIntegration', + 'changeSet' => [ + ['createdAt' => '2024-07-30T07:58:19.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventBridgeIntegration'], + ], + ], + 'ramActions' => [], + ], + 'DeleteGrafanaResource' => [ + 'summary' => 'Deletes Grafana dashboard resources from a Managed Service for Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ManagedType', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '托管类型：'."\n" - .'- none： 非托管。ACK集群的默认值。'."\n" - .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" - .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', - 'description' => 'Whether agents or exporters are managed. Valid values:'."\n" - ."\n" - .'* none: No. By default, no managed agents or exporters are provided for ACK clusters.'."\n" - .'* agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters.'."\n" - .'* agent-exproter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'agent', - 'enum' => [ - 'none', - 'agent', - 'agent-exporter', - ], - ], + 'name' => 'ClusterName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'clusterNameOfTest', 'title' => ''], ], [ - 'name' => 'CreateAuthToken', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否创建Token，以提升数据读取安全性。', - 'description' => 'Specifies whether to create a token to improve data security.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'false', - ], + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'Data' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'delete success.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '771DC66C-C5E0-59BC-A983-DD18FEE9EFFA', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates a successful request, whereas others indicate a failed request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'InitEnvironment', - ], - 'DescribeEnvironment' => [ - 'summary' => 'Queries the details of an environment.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"delete success.\\",\\n \\"RequestId\\": \\"771DC66C-C5E0-59BC-A983-DD18FEE9EFFA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGrafanaResourceResponse>\\n <Data>delete success.</Data>\\n <RequestId>771DC66C-C5E0-59BC-A983-DD18FEE9EFFA</RequestId>\\n</DeleteGrafanaResourceResponse>","errorExample":""}]', + 'title' => 'DeleteGrafanaResource', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGrafanaResource'], + ], ], + 'ramActions' => [], + ], + 'DeleteGrafanaWorkspace' => [ + 'summary' => 'Deletes a Managed Service for Grafana workspace instance.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free', 'autoTest' => false, 'notSupportAutoTestReason' => '涉及数据库任务，为了客户恢复需求，数据库资源不做释放，自动化调用资源浪费'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID. Default value: ap-southeast-1.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnvironmentId', + 'name' => 'GrafanaWorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['description' => 'The Managed Service for Grafana workspace ID.', 'type' => 'string', 'required' => true, 'example' => 'grafana-rnglkcdrntlhk0****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'The response parameters.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'EnvironmentType' => [ - 'description' => 'The type of the environment. Valid values:'."\n" - ."\n" - .'* CS: Container Service for Kubernetes (ACK)'."\n" - .'* ECS: Elastic Compute Service'."\n" - .'* Cloud: cloud service'."\n", - 'type' => 'string', - 'example' => 'CS', - ], - 'EnvironmentName' => [ - 'description' => 'The environment name.'."\n", - 'type' => 'string', - 'example' => 'env1', - ], - 'EnvironmentSubType' => [ - 'description' => 'Environment subtypes:'."\n" - .'- CS: Currently supports ACK.'."\n" - .'- ECS: ECS is currently supported.'."\n" - .'- Cloud: Currently supports Cloud.', - 'type' => 'string', - 'example' => 'ACK', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '13002222xxxx', - ], - 'BindResourceId' => [ - 'description' => 'The ID of the resource associated with the environment, such as the ACK cluster ID or VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-xxxxx', - ], - 'BindResourceType' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'ECS', - ], - 'BindResourceStatus' => [ - 'description' => 'The status of the resource.'."\n", - 'type' => 'string', - 'example' => 'running', - ], - 'BindResourceProfile' => [ - 'description' => 'The profile of the resource.'."\n", - 'type' => 'string', - 'example' => 'Default', - ], - 'BindVpcCidr' => [ - 'description' => 'The VPC CIDR block.'."\n", - 'type' => 'string', - 'example' => '192.168.0.0/16', - ], - 'PrometheusInstanceId' => [ - 'title' => '绑定的prometheus实例ID', - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'xxxxyyyyyzzzzz', - ], - 'PrometheusInstanceName' => [ - 'title' => '绑定的prometheus实例名称', - 'description' => 'The name of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'name1', - ], - 'GrafanaWorkspaceId' => [ - 'title' => 'grafana工作区id', - 'description' => 'The ID of the Grafana workspace.'."\n", - 'type' => 'string', - 'example' => 'grafana-cn-27a3m8eem0a', - ], - 'GrafanaFolderUid' => [ - 'description' => 'The unique ID of the Grafana directory.'."\n", - 'type' => 'string', - 'example' => 'xyz', - ], - 'GrafanaDatasourceUid' => [ - 'description' => 'The unique ID of the Grafana data source.'."\n", - 'type' => 'string', - 'example' => 'zuvw', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-8vb02uk57qbcktqcvqqqj', - ], - 'GrafanaFolderUrl' => [ - 'description' => 'The URL of the Grafana directory.'."\n", - 'type' => 'string', - 'example' => 'https://g.console.aliyun.com/dashboards/f/xxx/yyyy', - ], - 'BindResourceStoreDuration' => [ - 'title' => '单位 天', - 'description' => 'The retention period of the resource. Unit: days.'."\n", - 'type' => 'string', - 'example' => '15', - ], - 'GrafaDataSourceName' => [ - 'title' => '', - 'description' => 'The name of the Grafana data source.'."\n", - 'type' => 'string', - 'example' => 'datasource1', - ], - 'GrafanaFolderTitle' => [ - 'title' => '', - 'description' => 'The name of the Grafana directory.'."\n", - 'type' => 'string', - 'example' => 'folder1', - ], - 'ManagedType' => [ - 'title' => '托管类型：'."\n" - .'- none： 非托管。ACK集群的默认值。'."\n" - .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" - .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', - 'description' => 'managed type:'."\n" - .'- none: unmanaged. The default value for ACK clusters.'."\n" - .'- agent: managed agent (including KSM). The default values for ASK, ACS, and AckOne clusters.'."\n" - .'- agent-exporter: managed agent and exporters. The default value for the cloud service type.', - 'type' => 'string', - 'enumValueTitles' => [ - 'agent' => 'managed agent', - 'agent-exporter' => 'managed agent and exporter', - 'none' => 'unmanaged', - ], - 'example' => 'none', - ], - 'FeePackage' => [ - 'title' => '付费套餐。'."\n" - .'* EnvironmentType为CS时：可选为CS_Basic或CS_Pro。'."\n" - .'* EnvironmentType为其它值时，为空值。', - 'description' => 'The payable resource plan. Valid values:'."\n" - ."\n" - .'* If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro.'."\n" - .'* Otherwise, leave the parameter empty.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CS_Pro' => '', - 'CS_Basic' => '', - ], - 'example' => 'CS_Basic', - ], - 'DbInstanceStatus' => [ - 'title' => '绑定的prometheus实例db状态。', - 'description' => 'The status of the database that is bound to the Prometheus instance.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* UNINSTALLING'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* INSTALLING'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* UNINSTALLED'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* RUNNING'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* MODIFYING'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'UNINSTALLING' => 'UNINSTALLING', - 'INSTALLING' => 'INSTALLING', - 'UNINSTALLED' => 'UNINSTALLED', - 'RUNNING' => 'RUNNING', - 'MODIFYING' => 'MODIFYING', - ], - 'example' => 'RUNNING', - ], - 'SecurityGroupId' => [ - 'title' => '环境绑定的安全组Id', - 'description' => 'The ID of the security group associated with the environment.'."\n", - 'type' => 'string', - 'example' => 'sg-8vbdgmf4nraiqa9bx0jo', - ], - 'VswitchId' => [ - 'title' => '环境绑定的交换机Id', - 'description' => 'The ID of the vSwitch associated with the environment.'."\n", - 'type' => 'string', - 'example' => 'vsw-2ze7yr3f1x8snryaioo7u', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2vezare****', - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'p_dev', - ], - ], - ], - ], - ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****'], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success. Other values indicate errors.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The operation was successful.'."\n" + .'- `false`: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TraceId' => ['description' => 'The trace ID, which is used to query the details of the call.', 'type' => 'string', 'example' => 'eac0a8048716731735000007137d000b', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the Grafana workspace was deleted. Valid values:'."\n" + .'- true: The workspace was deleted.'."\n" + .'- false: The workspace failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ResourceIdIsIllegal', 'errorMessage' => 'The specified ResourceId is invalid.', 'description' => 'The parameter ResourceId is illegal.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['errorCode' => 'AccountUidAccessError', 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"EnvironmentType\\": \\"CS\\",\\n \\"EnvironmentName\\": \\"env1\\",\\n \\"EnvironmentSubType\\": \\"ACK\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UserId\\": \\"13002222xxxx\\",\\n \\"BindResourceId\\": \\"vpc-xxxxx\\",\\n \\"BindResourceType\\": \\"ECS\\",\\n \\"BindResourceStatus\\": \\"running\\",\\n \\"BindResourceProfile\\": \\"Default\\",\\n \\"BindVpcCidr\\": \\"192.168.0.0/16\\",\\n \\"PrometheusInstanceId\\": \\"xxxxyyyyyzzzzz\\",\\n \\"PrometheusInstanceName\\": \\"name1\\",\\n \\"GrafanaWorkspaceId\\": \\"grafana-cn-i7m2qn9xa01\\",\\n \\"GrafanaFolderUid\\": \\"xyz\\",\\n \\"GrafanaDatasourceUid\\": \\"zuvw\\",\\n \\"VpcId\\": \\"vpc-8vb02uk57qbcktqcvqqqj\\",\\n \\"GrafanaFolderUrl\\": \\"https://g.console.aliyun.com/dashboards/f/xxx/yyyy\\",\\n \\"BindResourceStoreDuration\\": \\"15\\",\\n \\"GrafaDataSourceName\\": \\"datasource1\\",\\n \\"GrafanaFolderTitle\\": \\"folder1\\",\\n \\"ManagedType\\": \\"none\\",\\n \\"FeePackage\\": \\"CS_Basic\\",\\n \\"DbInstanceStatus\\": \\"RUNNING\\",\\n \\"SecurityGroupId\\": \\"sg-8vbdgmf4nraiqa9bx0jo\\",\\n \\"VswitchId\\": \\"vsw-2ze7yr3f1x8snryaioo7u\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"user1\\",\\n \\"Value\\": \\"p_运维\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'DescribeEnvironment', - ], - 'UpdateEnvironment' => [ - 'summary' => 'Updates the configuration of an environment.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete a grafana workspace', + 'description' => '<props="china">>'."\n" + .'> - This operation supports deletion only for beta (`free`) Grafana instances.'."\n" + .'> - Developer Edition, Pro Edition, and Advanced Edition instances do not support deletion. Go to [Expenses and Costs](https://usercenter2.aliyun.com/refund/refund) to unsubscribe from the resource.</props>'."\n" + ."\n" + .'<props="intl"></props>'."\n" + .'> This operation supports deletion only for beta (`free`) Grafana instances.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGrafanaWorkspace'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteGrafanaWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'DeleteIMRobot' => [ + 'summary' => 'Deletes an instant messaging (IM) chatbot.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11197,78 +8219,70 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'RobotId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the IM chatbot.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID. You can use the ID to find logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'IsSuccess' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteIMRobotResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteIMRobotResponse>","errorExample":""}]', + 'title' => 'DeleteIMRobot', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIMRobot'], + ], + ], + ], + 'DeleteIntegration' => [ + 'summary' => 'Deletes the collection rules for a Container Service for Kubernetes (ACK) cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['description' => 'The ID of the ACK cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'EnvironmentName', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '环境名称', - 'description' => 'The name of the environment instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'env1', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FeePackage', + 'name' => 'Integration', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '付费套餐。'."\n" - .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" - .'* EnvironmentType为其它值时，请输入空值。', - 'description' => 'The payable resource plan. Valid values:'."\n" - ."\n" - .'* If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro. Default value: CS_Basic.'."\n" - .'* Otherwise, leave the parameter empty.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'CS_Basic', - 'enum' => [ - 'CS_Basic', - 'CS_Pro', - ], - ], + 'schema' => ['description' => 'The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'asm', 'title' => ''], ], ], 'responses' => [ @@ -11278,49 +8292,35 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '70675725-8F11-4817-8106-CFE0AD71****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Data' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'returnType' => 'synchronous', + 'substitutions' => ['ARMS::2019-08-08::DeleteAddonRelease'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'UpdateEnvironment', - ], - 'ListEnvironments' => [ - 'summary' => 'Queries environments.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeleteIntegration', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-21T03:12:11.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegration'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIntegrationResponse>\\n <RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n <Data>success</Data>\\n</DeleteIntegrationResponse>","errorExample":""}]', + ], + 'DeleteIntegrations' => [ + 'summary' => 'Deletes an alert integration.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -11328,1693 +8328,778 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '190992', - 'abilityTreeNodes' => [ - 'FEATUREarmsC7S24K', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'EnvironmentType', + 'name' => 'IntegrationId', 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the alert integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '环境类型 CS(容器) | ECS. addonName和environmentType至少填一个', - 'description' => 'The environment type. You must specify at least one of the AddonName and EnvironmentType parameters.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CS'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' Container Service for Kubernetes (ACK)'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* ECS'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' Elastic Compute Service (ECS)'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* Cloud'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' :'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' cloud service'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CS' => 'Container service', - 'ECS' => 'ECS service', - 'Cloud' => 'Cloud service', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****'], + 'IsSuccess' => ['title' => '', 'description' => 'Indicates whether the alert integration is deleted. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], ], - 'example' => 'CS', + 'example' => '', ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '非必填, regionId', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteIntegrationsResponse>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteIntegrationsResponse>","errorExample":""}]', + 'title' => 'DeleteIntegrations', + 'changeSet' => [ + ['createdAt' => '2022-06-24T02:52:43.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrations'], ], + ], + 'ramActions' => [], + ], + 'DeleteNotificationPolicy' => [ + 'summary' => 'Deletes a notification policy based on its ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AddonName', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon的名称, addonName和environmentType至少填一个', - 'description' => 'The add-on name. You must specify at least one of the AddonName and EnvironmentType parameters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'trace-java', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aekzfurdatohtka', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the notification policy.'."\n" + ."\n" + .'For more information about how to obtain the ID of a notification policy, see [ListNotificationPolicies](~~2612375~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tag value.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'env', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'gfn_web_outbound_add', - ], - ], - 'required' => false, + 'title' => 'Schema of Response', + 'description' => 'The operation that you want to perform. Set the value to **DeleteNotificationPolicy**.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the notification policy.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'IsSuccess' => ['description' => 'The ID of the request.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteNotificationPolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteNotificationPolicyResponse>","errorExample":""}]', + 'title' => 'DeleteNotificationPolicy', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNotificationPolicy'], + ], + ], + 'ramActions' => [], + ], + 'DeletePrometheusAlertRule' => [ + 'summary' => 'Deletes an alert rule of Prometheus Service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BindResourceId', - 'in' => 'query', - 'schema' => [ - 'title' => '绑定的资源ID。', - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cff30f0d67d7542dfb05bd114b4b1d7af', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'delete'], + 'parameters' => [ [ - 'name' => 'FeePackage', + 'name' => 'AlertId', 'in' => 'query', - 'schema' => [ - 'description' => 'The payable resource plan.'."\n" - ."\n" - .'* If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro. Default value: CS_Basic.'."\n" - .'* Otherwise, leave the parameter empty.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* CS_Pro: Container Monitoring Pro'."\n" - .'* CS_Basic: Container Monitoring Basic'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'CS_Pro' => 'Container Monitoring Pro', - 'CS_Basic' => 'Container Monitoring Basi', - ], - 'example' => 'CS_Pro', - ], + 'schema' => ['description' => 'The ID of the alert rule. You can call the ListPrometheusAlertRules operation to query the ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '0', 'example' => '3888704', 'title' => ''], ], [ - 'name' => 'FilterRegionIds', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '指定Region查询。', - 'description' => 'The region IDs to be queried.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing,cn-hangzhou', - ], + 'schema' => ['description' => 'The cluster ID of the Prometheus monitoring alarm rule.', 'type' => 'string', 'required' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Environments' => [ - 'description' => 'The queried environments.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Environment details.', - 'type' => 'object', - 'properties' => [ - 'Addons' => [ - 'description' => 'The add-ons.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Addon details.', - 'type' => 'object', - 'properties' => [ - 'Alias' => [ - 'description' => 'The alias of the add-on.'."\n", - 'type' => 'string', - 'example' => 'MySQL Exporter', - ], - 'Description' => [ - 'description' => 'The description of the add-on.'."\n", - 'type' => 'string', - 'example' => 'Collect mysql indicator information', - ], - 'Icon' => [ - 'description' => 'The URL of the icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', - ], - 'Name' => [ - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'metric-agent', - ], - ], - ], - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '13990957477389', - ], - 'BindResourceId' => [ - 'description' => 'The ID of the resource bound to the environment instance. The resource can be a Kubernetes cluster or a VPC.'."\n", - 'type' => 'string', - 'example' => 'vpc-bp1bgo8ronn', - ], - 'BindResourceProfile' => [ - 'description' => 'The profile that is bound to the resource.'."\n", - 'type' => 'string', - 'example' => 'xxx', - ], - 'BindResourceType' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'VPC', - ], - 'BindVpcCidr' => [ - 'description' => 'The CIDR block that is bound to the VPC.'."\n", - 'type' => 'string', - 'example' => '172.16.0.0/12', - ], - 'CreateTime' => [ - 'description' => 'The time when the environment instance was created.'."\n", - 'type' => 'string', - 'example' => '2023-03-24 11:58:35 +0800', - ], - 'CreatedUserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '12378523784982', - ], - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxx', - ], - 'EnvironmentName' => [ - 'description' => 'The name of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'feiliks-biz-prod-edas', - ], - 'EnvironmentType' => [ - 'description' => 'The type of the environment instance. Valid values:'."\n" - ."\n" - .'* CS: Container Service'."\n" - .'* ECS: Elastic Compute Service'."\n" - .'* Cloud: cloud service'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'CS' => 'Container service', - 'ECS' => 'ECS service', - 'Cloud' => 'Cloud service', - ], - 'example' => 'CS', - ], - 'Features' => [ - 'description' => 'The parameters of the feature.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Feature details.', - 'type' => 'object', - 'properties' => [ - 'Alias' => [ - 'description' => 'The alias of the feature.'."\n", - 'type' => 'string', - 'example' => 'Prometheus Agent', - ], - 'Description' => [ - 'description' => 'The description of the feature.'."\n", - 'type' => 'string', - 'example' => 'Collect Metric data using the Prometheus collection specification', - ], - 'Icon' => [ - 'description' => 'The URL of the icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', - ], - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'metirc-agent', - ], - ], - ], - ], - 'GrafanaFolderTitle' => [ - 'description' => 'The name of the Grafana directory.'."\n", - 'type' => 'string', - 'example' => 'filepath', - ], - 'GrafanaFolderUid' => [ - 'description' => 'The unique ID of the Grafana directory.'."\n", - 'type' => 'string', - 'example' => '1798319482935', - ], - 'PrometheusId' => [ - 'description' => 'The Prometheus ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '124769812', - ], - 'PrometheusInstanceId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'vpc-m5e4alj2i24ndbn', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmvt3xpr5aema', - ], - 'Tags' => [ - 'description' => 'The tags of the environment resource.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Resource tag value.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'fpx-tag', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - ], - ], - ], - 'GrafanaDatasourceUid' => [ - 'description' => 'The unique ID of the Grafana data source.'."\n", - 'type' => 'string', - 'example' => '12374890', - ], - 'ReleaseCount' => [ - 'description' => 'The number of installed add-ons.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '122', - ], - 'LatestReleaseCreateTime' => [ - 'description' => 'The time when the last add-on was created.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'ManagedType' => [ - 'description' => 'Indicates whether agents or exporters are managed. Valid values:'."\n" - ."\n" - .'* none: No. By default, no managed agents or exporters are provided for ACK clusters.'."\n" - .'* agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters.'."\n" - .'* agent-exproter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.'."\n", - 'type' => 'string', - 'example' => 'agent', - ], - 'FeePackage' => [ - 'description' => 'The payable resource plan.'."\n" - ."\n" - .'* If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro.'."\n" - .'* Otherwise, leave the parameter empty.'."\n", - 'type' => 'string', - 'example' => 'CS_Pro', - ], - ], - ], - ], - 'Total' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" + ."\n" + .'- `true`: The alert rule was deleted.'."\n" + ."\n" + .'- `false`: The alert rule failed to be deleted.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'More Information.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Environments\\": [\\n {\\n \\"Addons\\": [\\n {\\n \\"Alias\\": \\"Prometheus探针\\",\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据\\",\\n \\"Icon\\": \\"http://xxxx\\",\\n \\"Name\\": \\"metric-agent\\"\\n }\\n ],\\n \\"UserId\\": \\"13990957477389\\",\\n \\"BindResourceId\\": \\"vpc-bp1bgo8ronn\\",\\n \\"BindResourceProfile\\": \\"xxx\\",\\n \\"BindResourceType\\": \\"VPC\\",\\n \\"BindVpcCidr\\": \\"172.16.0.0/12\\",\\n \\"CreateTime\\": \\"2023-03-24 11:58:35 +0800\\",\\n \\"CreatedUserId\\": \\"12378523784982\\",\\n \\"EnvironmentId\\": \\"env-xxx\\",\\n \\"EnvironmentName\\": \\"feiliks-biz-prod-edas\\",\\n \\"EnvironmentType\\": \\"CS\\",\\n \\"Features\\": [\\n {\\n \\"Alias\\": \\"Prometheus 探针\\",\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据\\",\\n \\"Icon\\": \\"http://xxx\\",\\n \\"Name\\": \\"metirc-agent\\"\\n }\\n ],\\n \\"GrafanaFolderTitle\\": \\"filepath\\",\\n \\"GrafanaFolderUid\\": \\"1798319482935\\",\\n \\"PrometheusId\\": 124769812,\\n \\"PrometheusInstanceId\\": \\"vpc-m5e4alj2i24ndbn\\",\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvt3xpr5aema\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"fpx-tag\\",\\n \\"Value\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"GrafanaDatasourceUid\\": \\"12374890\\",\\n \\"ReleaseCount\\": 122,\\n \\"LatestReleaseCreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"ManagedType\\": \\"agent\\",\\n \\"FeePackage\\": \\"CS_Pro\\"\\n }\\n ],\\n \\"Total\\": 12\\n }\\n}","type":"json"}]', - 'title' => 'ListEnvironments', - ], - 'DeleteEnvironment' => [ - 'summary' => 'Deletes an environment instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'DeletePrometheusAlertRule', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-31T01:50:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-14T01:39:26.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusAlertRule'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeletePrometheusGlobalView' => [ + 'summary' => 'Deletes a global aggregation instance from Prometheus Service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxxx', - ], - ], - [ - 'name' => 'DeletePromInstance', + 'name' => 'GlobalViewClusterId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否级联删除prometheus实例。', - 'description' => 'Specifies whether to delete the related Prometheus instance.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'global-v2-cn-1670100631025794-amaykca4', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果描述', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'Data' => ['description' => 'The response parameters in the JSON format.'."\n", 'type' => 'string', 'example' => '{"Success":true,"Msg":"OK"}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates a successful request, whereas others indicate a failed request.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The supplemental message providing additional context about the response.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'DeleteEnvironment', - ], - 'DescribeAddonMetrics' => [ - 'summary' => 'Queries the metric details of a component.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'DeletePrometheusGlobalView', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-03T06:53:35.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusGlobalView'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\"Success\\\\\\":true,\\\\\\"Msg\\\\\\":\\\\\\"OK\\\\\\"}\\",\\n \\"RequestId\\": \\"337B8F7E-0A64-5768-9225-E9B3CF******\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePrometheusGlobalViewResponse>\\n <Data>{\\"Success\\":true,\\"Msg\\":\\"OK\\"}</Data>\\n <RequestId>337B8F7E-0A64-5768-9225-E9B3CF******</RequestId>\\n</DeletePrometheusGlobalViewResponse>","errorExample":""}]', + ], + 'DeletePrometheusIntegration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon名称', - 'description' => 'The name of the component.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysql', - ], - ], - [ - 'name' => 'AddonVersion', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'Addon版本号', - 'description' => 'The version of the component.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.0.1', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'EnvironmentType', + 'name' => 'IntegrationType', 'in' => 'query', - 'schema' => [ - 'title' => '环境', - 'description' => 'The environment.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CS', - ], + 'schema' => ['title' => '', 'description' => 'The type of the integration.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kafka、mysql等。'], ], [ - 'name' => 'RegionId', + 'name' => 'InstanceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the exporter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2875', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', - ], - 'Code' => [ - 'title' => '状态码, 200为正常, 其他为异常', - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '提示消息', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'title' => '业务是否成功', - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The metric details.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metric details.'."\n", - 'type' => 'object', - 'properties' => [ - 'Group' => [ - 'description' => 'The metric group.'."\n", - 'type' => 'string', - 'example' => 'Common', - ], - 'Labels' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the tag.'."\n", - 'type' => 'string', - 'example' => 'The number of times a B-tree page of size PAGE_SIZE was successfully compressed.', - ], - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'page_size', - ], - 'Source' => [ - 'description' => 'The source of the tag.'."\n", - 'type' => 'string', - 'example' => 'db', - ], - ], - ], - ], - 'Metrics' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The metrics.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the metric.'."\n", - 'type' => 'string', - 'example' => 'The number of times a B-tree page of size PAGE_SIZE was successfully compressed.', - ], - 'Labels' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the tag.'."\n", - 'type' => 'string', - 'example' => 'PAGE_SIZE', - ], - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'page_size', - ], - 'Source' => [ - 'description' => 'The source of the tag.'."\n", - 'type' => 'string', - 'example' => 'db', - ], - ], - ], - ], - 'Type' => [ - 'description' => 'The type of the metric.'."\n", - 'type' => 'string', - 'example' => 'GAUGE', - ], - 'Unit' => [ - 'description' => 'The unit of the metric.'."\n", - 'type' => 'string', - 'example' => 'bytes', - ], - 'Metric' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'example' => 'mysql_exporter_collector_duration_seconds', - ], - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '19F54318-CC92-5567-BF66-CB029EC44C84'], + 'Data' => ['title' => '', 'description' => 'success or an error message.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B6A00968-82A8-4F14-9D1B-B53827DB****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Group\\": \\"Common\\",\\n \\"Labels\\": [\\n {\\n \\"Description\\": \\"大小为PAGE_SIZE的B树页面被成功压缩的次数。\\\\n\\",\\n \\"Key\\": \\"page_size\\",\\n \\"Source\\": \\"db\\"\\n }\\n ],\\n \\"Metrics\\": [\\n {\\n \\"Description\\": \\"大小为PAGE_SIZE的B树页面被成功压缩的次数。\\\\n\\",\\n \\"Labels\\": [\\n {\\n \\"Description\\": \\"PAGE_SIZE\\",\\n \\"Key\\": \\"page_size\\",\\n \\"Source\\": \\"db\\"\\n }\\n ],\\n \\"Type\\": \\"GAUGE\\",\\n \\"Unit\\": \\"bytes\\",\\n \\"Metric\\": \\"mysql_exporter_collector_duration_seconds\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'DescribeAddonMetrics', - ], - 'InstallEnvironmentFeature' => [ - 'summary' => 'Installs a feature.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'DeletePrometheusIntegration', + 'summary' => 'Deletes an exporter from a Prometheus instance for Container Service or a Prometheus instance for ECS.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusIntegration'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"19F54318-CC92-5567-BF66-CB029EC44C84\\",\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'DeletePrometheusMonitoring' => [ + 'summary' => 'Deletes the monitoring configuration of a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => 'region id', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'FeatureName', + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the monitoring configuration. '."\n" + .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" + .'Valid values for a Prometheus instance for ECS: customJob and probe.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'probe'], + ], + [ + 'name' => 'MonitoringName', 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob1', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Feature的名称: app-agent-pilot,metric-agent,ebpf-agent,service-check', - 'description' => 'The name of the feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app-agent-pilot'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .'* metric-agent'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'app-agent-pilot' => 'Agent of app-pilot', - 'metric-agent' => 'Agent of metric collection', + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], - 'example' => 'metric-agent', + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'DeletePrometheusMonitoring', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusMonitoring'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'DeleteRetcodeApp' => [ + 'summary' => 'Deletes a Browser Monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FeatureVersion', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => 'Feature的版本信息', - 'description' => 'The version of the feature.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1.1.17', - ], + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => '1231', 'title' => ''], ], [ - 'name' => 'Config', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '用于填充的values', - 'description' => 'The metadata of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"continuous\\":true,\\"dataRevision\\":2}', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'Region', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'title' => 'region信息', - 'description' => 'The region ID of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'aokcdqn3ly@741623b4e91****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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' => 'message', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The release ID.'."\n", - 'type' => 'string', - 'example' => '83FCC44C-A056-18AF-A902-7043E723F0D9', - ], + 'Data' => ['description' => 'Indicates whether the Browser Monitoring task was deleted. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Whether the operation was successful:'."\n" + .'- `true`: The operation was successful'."\n" + .'- `false`: The operation failed', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'Additional information. The value description is as follows:'."\n" + .'- If the request is normal, return success.'."\n" + .'- If the request is abnormal, return specific abnormal information.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"83FCC44C-A056-18AF-A902-7043E723F0D9\\"\\n}","type":"json"}]', - 'title' => 'InstallEnvironmentFeature', - ], - 'DescribeEnvironmentFeature' => [ - 'summary' => 'Queries the details of a feature.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteRetcodeAppResponse>\\r\\n <data>true</data>\\r\\n <requestId>01FF8DD9-A09C-47A1-895A-B6E321BE77B6</requestId>\\r\\n</DeleteRetcodeAppResponse>","errorExample":""}]', + 'title' => 'DeleteRetcodeApp', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-27T11:18:37.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-05T06:43:33.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-29T09:40:47.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteRumApp' => [ + 'summary' => 'Deletes a RUM application.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'b590lhguqs@28f515462******', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'AppGroup', 'in' => 'query', - 'schema' => [ - 'title' => 'region id', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The group where the application resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'FeatureName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'feature的名称', - 'description' => 'The name of the feature.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* app-agent-pilot: App Pilot agent'."\n" - .'* arms-cmonitor: ARMS CMonitor agent'."\n" - .'* metric-agent: Prometheus agent'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'app-agent-pilot' => 'Agent of App Pilot', - 'arms-cmonitor' => '', - 'metric-agent' => 'Agent of Prometheus', - ], - 'example' => 'metric-agent', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'RealRegionId', 'in' => 'query', - 'schema' => [ - 'title' => '语言参数，en | zh。', - 'description' => 'The language. Valid values: en and zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'The region where the application resides. You can leave this parameter empty or set it to China East 2 Finance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-finance-1', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Feature' => [ - 'description' => 'The installation information about the feature.'."\n", - 'type' => 'object', - 'properties' => [ - 'Alias' => [ - 'description' => 'The alias of the feature.'."\n", - 'type' => 'string', - 'example' => 'Prometheus agent.', - ], - 'Config' => [ - 'description' => 'The configuration of the feature.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{}', - 'description' => 'The configuration of the feature.'."\n", - ], - ], - 'Description' => [ - 'description' => 'The description of the feature.'."\n", - 'type' => 'string', - 'example' => 'Collect Metric data using the Prometheus collection specification.', - ], - 'EnvironmentId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'Icon' => [ - 'description' => 'The URL of the icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', - ], - 'Language' => [ - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'LatestVersion' => [ - 'description' => 'The latest version number.'."\n", - 'type' => 'string', - 'example' => '1.1.17', - ], - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'metric-agent', - ], - 'Status' => [ - 'description' => 'The installation status of the agent.'."\n" - ."\n" - .'* Installing: The agent is being installed.'."\n" - .'* Success: The agent is installed.'."\n" - .'* Failed: The agent failed to be installed.'."\n" - .'* UnInstall: The agent is uninstalled or has not been installed.'."\n" - .'* Uninstalling: The agent is being uninstalled.'."\n" - .'* UnInstallFailed: The agent failed to be uninstalled.', - 'type' => 'string', - 'enumValueTitles' => [ - 'UnInstall' => '', - 'Failed' => '', - 'Installing' => '', - 'UnInstallFailed' => '', - 'Success' => '', - 'UnInstalling' => '', - ], - 'example' => 'Success', - ], - 'Version' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'example' => '1.1.17', - ], - 'Managed' => [ - 'description' => 'Indicates whether the component is fully managed.'."\n", - 'type' => 'boolean', - ], - ], - ], - 'FeatureStatus' => [ - 'description' => 'The status of the feature.'."\n", - 'type' => 'object', - 'properties' => [ - 'FeatureContainers' => [ - 'description' => 'The containers of the feature.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Feature container information.', - 'type' => 'object', - 'properties' => [ - 'Args' => [ - 'description' => 'The container parameters.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the parameter.'."\n", - 'type' => 'string', - 'example' => '['."\n" - .' "--port=9335",'."\n" - .' "--yaml=/etc/config/prometheusDisk/prometheus.yaml",'."\n" - .' "--chartVersion=1.1.17"'."\n" - .' ]', - ], - ], - 'Image' => [ - 'description' => 'The container image.'."\n", - 'type' => 'string', - 'example' => 'registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0', - ], - 'Name' => [ - 'description' => 'The container name.'."\n", - 'type' => 'string', - 'example' => 'arms-prometheus-operator', - ], - ], - ], - ], - 'Name' => [ - 'description' => 'The Kubernetes resource name of the feature.'."\n", - 'type' => 'string', - 'example' => 'arms-prometheus-ack-arms-prometheus', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'Status' => [ - 'description' => 'The status of the agent. Valid values:'."\n" - ."\n" - .'* Success: The agent is running.'."\n" - .'* Failed: The agent failed to run.'."\n" - .'* Not Found: The agent is not installed.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Failed' => 'Failed', - 'Not Found' => 'Not Found', - 'Success' => 'Success', - ], - 'example' => 'Success', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-bp1c9fcexoalq9po6cp8', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1qt6ict0dbxgv4wer8l', - ], - 'BindResourceId' => [ - 'description' => 'The ID of the resource.'."\n", - 'type' => 'string', - 'example' => 'c013823b55e4b4d6bb6b6f28682bd38a7', - ], - 'Ips' => [ - 'description' => 'The IP address of the pod.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '10.192.213.201', - ], - ], - ], - ], - 'config' => [ - 'description' => 'The feature configurations.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request is successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => '删除的应用不存在。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Result' => ['description' => 'The message that appears when the application is deleted.'."\n", 'type' => 'string', 'example' => '删除应用成功。', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-aek2eq4peca****', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Feature\\": {\\n \\"Alias\\": \\"Prometheus 探针\\",\\n \\"Config\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据。\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Icon\\": \\"http://xxx\\",\\n \\"Language\\": \\"zh\\",\\n \\"LatestVersion\\": \\"1.1.17\\",\\n \\"Name\\": \\"metric-agent\\",\\n \\"Status\\": \\"Success\\",\\n \\"Version\\": \\"1.1.17\\",\\n \\"Managed\\": true\\n },\\n \\"FeatureStatus\\": {\\n \\"FeatureContainers\\": [\\n {\\n \\"Args\\": [\\n \\"[\\\\n \\\\\\"--port=9335\\\\\\",\\\\n \\\\\\"--yaml=/etc/config/prometheusDisk/prometheus.yaml\\\\\\",\\\\n \\\\\\"--chartVersion=1.1.17\\\\\\"\\\\n ]\\"\\n ],\\n \\"Image\\": \\"registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0\\",\\n \\"Name\\": \\"arms-prometheus-operator\\"\\n }\\n ],\\n \\"Name\\": \\"arms-prometheus-ack-arms-prometheus\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"Status\\": \\"Success\\",\\n \\"SecurityGroupId\\": \\"sg-bp1gbhqh8b4dsgvopkry\\",\\n \\"VSwitchId\\": \\"vsw-uf6vc2e4ytv8vv05j3u09\\",\\n \\"BindResourceId\\": \\"c013823b55e4b4d6bb6b6f28682bd38a7\\",\\n \\"Ips\\": [\\n \\"10.178.176.187\\"\\n ]\\n },\\n \\"config\\": \\"{}\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeEnvironmentFeature', - 'requestParamsDescription' => 'You can call the [**ListEnvironmentFeatures**](~~ListEnvironmentFeatures~~) operation to query the feature information.', - ], - 'UpgradeEnvironmentFeature' => [ - 'summary' => 'Updates the feature information of an environment.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"删除的应用不存在。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Result\\": \\"删除应用成功。\\",\\n \\"ResourceGroupId\\": \\"rg-aek2eq4peca****\\"\\n}","type":"json"}]', + 'title' => 'DeleteRumApp', + 'changeSet' => [ + ['createdAt' => '2024-09-02T10:52:59.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'DeleteRumUploadFile' => [ + 'summary' => 'Deletes files such as symbol tables and SourceMap files.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The file version number.', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''], ], [ - 'name' => 'FeatureName', + 'name' => 'Uuid', 'in' => 'query', - 'schema' => [ - 'title' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', - 'description' => 'The feature name. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'metric-agent', - ], + 'schema' => ['description' => 'The unique ID of the file.', 'type' => 'string', 'required' => false, 'example' => 'MS4wLjAtbWFpbi4wZjM0NzRlOSxxxxxx', 'title' => ''], ], [ - 'name' => 'FeatureVersion', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'title' => 'feature的版本', - 'description' => 'The version of the feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1.1.17', - ], + 'schema' => ['description' => 'The file name, including the file name extension.', 'type' => 'string', 'required' => false, 'example' => 'test.js.map', 'title' => ''], ], [ - 'name' => 'Values', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '开关服务发现用, PodAnnotation | PodMonitor | ServiceMonitor, PodAnnotation开关是run和mini, pm和sm则传 true和false, 例如 {"PodAnnotation":"run"}', - 'description' => 'Specifies whether to enable service discovery. For PodAnnotation, set the value to run or mini. For PodMonitor and ServiceMonitor, set the value to true or false.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"PodAnnotation":"run"}', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'BatchItems', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The batch deletion parameters in JSON array format. Leave this parameter empty if you want to delete a single file. If you want to delete multiple files in a batch, specify only this parameter.', 'type' => 'string', 'required' => false, 'example' => '[{'."\n" + .' "fileName" : "test.js.map",'."\n" + .' "version" : "1.0.0"'."\n" + .' },'."\n" + .' {'."\n" + .' "fileName" : "test.dSYM",'."\n" + .' "version" : "1.20.1",'."\n" + .' "uuid" : "xxxx-xxxx-xxxx-xxxx"'."\n" + .' }]', 'title' => ''], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', - ], - 'Code' => [ - 'description' => 'The status code. 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', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The status of the job.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "PodAnnotation": "run"'."\n" - .' }', - 'description' => 'The status value.'."\n", - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****'], + 'Code' => ['description' => 'The status code. 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', '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' => ''], + 'Message' => ['description' => 'The error message.', 'type' => 'string', 'example' => '内部错误，请联系管理员。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the deletion was successful. The value success is returned if the deletion was successful.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Delete RUM file', + 'description' => 'Real User Monitoring is currently available only in Hangzhou, Singapore, and Silicon Valley. Select the correct endpoint.', + 'changeSet' => [ + ['createdAt' => '2025-08-22T06:39:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-15T12:28:26.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"PodAnnotation\\\\\\": \\\\\\"run\\\\\\"\\\\n }\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpgradeEnvironmentFeature', - ], - 'RestartEnvironmentFeature' => [ - 'summary' => 'Restarts a feature.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteRumUploadFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DeleteScenario' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'ScenarioId', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The ID of the environment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The ID of the business monitoring job. You can obtain the ID by calling the ListScenario operation.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'minimum' => '1', 'example' => '132', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjaikou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'Result' => ['description' => 'Indicates whether the request is successful.'."\n" + ."\n" + .'* `true`: successful'."\n" + .'* `false`: failed'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'EA24D522-AD35-47B8-8CB2-ADBC382B****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"EA24D522-AD35-47B8-8CB2-ADBC382B****\\"\\n}","type":"json"}]', + 'title' => 'Delete Business Monitoring', + 'summary' => 'Delete a Business Monitoring.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-27T02:52:44.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'DeleteSilencePolicy' => [ + 'summary' => 'Deletes a silence policy based on its ID.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'FeatureName', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'title' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', - 'description' => 'The feature name. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'metric-agent', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the silence policy.'."\n" + ."\n" + .'For more information about how to obtain the ID of a silence policy, see [ListSilencePolicies](~~2612383~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'success.', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The operation that you want to perform. Set the value to **DeleteSilencePolicy**.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'IsSuccess' => ['title' => '', 'description' => 'Indicates whether the silence policy was deleted successfully. Valid values:'."\n" + ."\n" + .'* `true`: The silence policy was deleted successfully.'."\n" + .'* `false`: The silence policy failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true'], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success.\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'RestartEnvironmentFeature', - ], - 'ListEnvironmentFeatures' => [ - 'summary' => 'Queries the features in an environment.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteSilencePolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteSilencePolicyResponse>","errorExample":""}]', + 'title' => 'DeleteSilencePolicy', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSilencePolicy'], + ], ], + 'ramActions' => [], + ], + 'DeleteSourceMap' => [ + 'summary' => 'Deletes the SourceMap files uploaded in Browser Monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'required' => true, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'FidList', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '语言环境 zh | en，默认为中文。', - 'description' => 'The language. Default value: zh.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* en: English.'."\n" - .'* zh: Chinese.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => '', - 'zh' => '', - ], - 'example' => 'en', + 'description' => 'The IDs of the SourceMap files.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IDs of the SourceMap files.'."\n", 'type' => 'string', 'required' => false, 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', 'title' => ''], + 'required' => true, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', - ], - 'Code' => [ - 'description' => 'Status Code. Description 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" - ."\n" - .'* `true`: The alert rule was deleted.'."\n" - .'* `false`: The alert rule failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Config' => [ - 'description' => 'The feature configuration.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The feature configuration.'."\n", - 'example' => '{}', - ], - ], - 'Description' => [ - 'description' => 'The description of the feature.'."\n", - 'type' => 'string', - 'example' => 'Collect Metric data using the Prometheus collection specification.', - ], - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'Language' => [ - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* zh: Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'LatestVersion' => [ - 'description' => 'The latest version number.'."\n", - 'type' => 'string', - 'example' => '1.1.17', - ], - 'Name' => [ - 'description' => 'The name of the feature.'."\n", - 'type' => 'string', - 'example' => 'metric-agent', - ], - 'Status' => [ - 'description' => 'The status of the feature. Valid values:'."\n" - ."\n" - .'* Installing: The agent is being installed.'."\n" - .'* Success: The agent is installed.'."\n" - .'* Failed: The agent failed to be installed.'."\n" - .'* UnInstall: The agent is uninstalled.'."\n" - .'* Uninstalling: The agent is being uninstalled.'."\n" - .'* UnInstallFailed: The agent failed to be uninstalled.'."\n", - 'type' => 'string', - 'example' => 'Success', - ], - 'Version' => [ - 'description' => 'The version of the feature.'."\n", - 'type' => 'string', - 'example' => '1.1.17', - ], - 'Alias' => [ - 'description' => 'The alias of the feature.'."\n", - 'type' => 'string', - 'example' => 'Prometheus Agent', - ], - 'Icon' => [ - 'description' => 'The URL of the icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', - ], - 'Managed' => [ - 'description' => 'Indicates whether the component is fully managed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Data' => ['description' => 'Indicates whether the SourceMap files are deleted. Valid values:'."\n" + ."\n" + .'* success: The SourceMap files are deleted.'."\n" + .'* false: The SourceMap files fail to be deleted.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Config\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据。\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Language\\": \\"zh\\",\\n \\"LatestVersion\\": \\"1.1.17\\",\\n \\"Name\\": \\"metric-agent\\",\\n \\"Status\\": \\"Success\\",\\n \\"Version\\": \\"1.1.17\\",\\n \\"Alias\\": \\"Prometheus 探针\\",\\n \\"Icon\\": \\"http://xxx\\",\\n \\"Managed\\": true\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListEnvironmentFeatures', - ], - 'DeleteEnvironmentFeature' => [ - 'summary' => 'Deletes a feature.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'DeleteSourceMap', + 'changeSet' => [ + ['createdAt' => '2022-07-26T12:41:04.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSourceMap'], + ], ], + 'ramActions' => [], + ], + 'DeleteSyntheticTask' => [ + 'summary' => 'Deletes scheduled synthetic monitoring tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The ID of the environment.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '地域id cn-beijing | cn-hangzhou', - 'description' => 'The region ID. Valid values: cn-beijing and cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'FeatureName', + 'name' => 'TaskIds', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', - 'description' => 'The feature name. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check.'."\n", - 'type' => 'string', + 'description' => 'The task IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'required' => false, 'example' => '16720', 'title' => ''], 'required' => true, - 'example' => 'metric-agent', + 'maxItems' => 30, + 'title' => '', + 'example' => '', ], ], ], @@ -13025,190 +9110,111 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Result' => ['description' => 'Indicates whether the specified tasks are deleted.'."\n" + ."\n" + .'* `true`: The tasks are deleted.'."\n" + .'* `false`: The tasks fail to be deleted.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'DeleteSyntheticTask', + 'changeSet' => [], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSyntheticTask'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteEnvironmentFeature', ], - 'CreateEnvCustomJob' => [ - 'summary' => 'Creates a custom job for an environment.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DeleteTimingSyntheticTask' => [ + 'summary' => 'Deletes a scheduled synthetic monitoring task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'required' => false, 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', 'title' => ''], ], [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '环境实例ID', - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'env-xxxxxx', - ], - ], - [ - 'name' => 'CustomJobName', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '自定义job名称', - 'description' => 'The name of the custom job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob1', - ], - ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'title' => '示例：'."\n" - .'`'."\n" - .'scrape_configs:'."\n" - .'- job_name: job-demo'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scrape_interval: 30s'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - .'`'."\n", - 'description' => 'The YAML configuration string of the custom job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Refer to supplementary instructions.', - ], + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-aek2eq4peca****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '返回成功增加的customJob名称，或异常信息。', - 'description' => 'The name of the custom job that was created, or the exception information.'."\n", - 'type' => 'string', - 'example' => 'cutomJob1', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the synthetic monitoring task was deleted. true: The synthetic monitoring task was deleted. false: The synthetic monitoring task failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => 'task count limited', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => 'The specified region is invalid.', 'description' => 'The specified region is invalid.'], + ], + 403 => [ + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => 'synthetic trail has expired', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => 'synthetic is in debt', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => 'synthetic dailly times has exhausted', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => 'synthetic dailly limited', 'description' => ''], + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'SubUser permission verification failed, the caller is not authorized to perform %s on resource %s.', 'description' => 'Authentication failed because the RAM user is not authorized to perform the %s operation on the %s resource.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => 'Abnormal commercialization status. Please contact your administrator.', 'description' => 'Abnormal commercialization status. Please contact your administrator.'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"cutomJob1\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CreateEnvCustomJob', - ], - 'UpdateEnvCustomJob' => [ - 'summary' => 'Updates a custom job for an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'DeleteTimingSyntheticTask', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'changeSet' => [ + ['createdAt' => '2023-08-24T12:37:10.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-24T12:11:03.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTimingSyntheticTask'], + ], ], + ], + 'DeleteTraceApp' => [ + 'summary' => 'Deletes an application based on a specified process identifier (PID) and application type.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13216,84 +9222,137 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the application that you want to delete. You can call the SearchTraceAppByName operation to query the application ID. For more information, see [SearchTraceAppByName](~~130676~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '5406**', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The ID of the region in which the application is located.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnvironmentId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['description' => 'The type of the application that you want to delete. You can call the SearchTraceAppByName operation to query the application type. For more information, see [SearchTraceAppByName](~~130676~~). Valid values:'."\n" + ."\n" + .'* `TRACE`: Application Monitoring'."\n" + .'* `RETCODE`: frontend monitoring'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TRACE', 'title' => ''], ], [ - 'name' => 'CustomJobName', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob1', - ], + 'schema' => ['description' => 'The PID of the application. For more information about how to query the PID, see [QueryMetricByPage](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '9w0sc5gxxz@edcsd447c2f****', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'DeleteReason', 'in' => 'query', - 'allowEmptyValue' => true, + 'style' => 'json', 'schema' => [ - 'title' => '自定义任务状态: run 或 stop', - 'description' => 'The status of the custom job. Valid values: run and stop.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'run', - 'enum' => [ - 'run', - 'stop', + 'description' => 'The reason(s) to delete application.', + 'type' => 'object', + 'properties' => [ + 'Remark' => ['description' => 'Additional remarks when none of the reasons for removal provided are met.', 'type' => 'string', 'required' => false, 'example' => '业务场景覆盖不全', 'title' => ''], + 'ReasonIds' => [ + 'description' => 'Reasons Ids.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the reason for deletion.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Name' => ['description' => 'A description of the reason for removal.', 'type' => 'string', 'required' => false, 'example' => '删除理由描述，ID和Name的对应关系：'."\n" + .'"id":0,"name":"功能不完善，无法定位到问题根本原因。"'."\n" + .'"id":1,"name":"Agent不稳定，影响应用运行。"'."\n" + .'"id":2,"name":"服务不稳定，经常打不开界面。"'."\n" + .'"id":3,"name":"报警相关问题。"'."\n" + .'"id":4,"name":"价格太贵"'."\n" + .'"id":5,"name":"其他原因"', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The YAML configuration string.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Refer to supplementary instructions.', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The response in JSON format, including the HTTP status code, error code, response message, and trace ID.'."\n", 'type' => 'string', 'example' => '{\\"code\\":200,\\"data\\":\\"{\\\\\\"code\\\\\\":200,\\\\\\"data\\\\\\":true,\\\\\\"errorCode\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"message\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"success\\\\\\":true,\\\\\\"traceId\\\\\\":\\\\\\"0bc0594d15954826692915817e****\\\\\\"}\\",\\"errorCode\\":\\"删除应用成功\\",\\"message\\":\\"删除应用成功\\",\\"success\\":true,\\"traceId\\":\\"0ab2646915954826692568137d****\\"}', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'true: The request was successful.'."\n" + ."\n" + .'false: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], + 'errorCodes' => [ + 403 => [ + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ], + 406 => [ + ['errorCode' => 'AgentNotUninstalled', 'errorMessage' => 'agent not uninstalled.', 'description' => 'The agent attached by the application is not uninstalled normally.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"code\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":200,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"data\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"0bc0594d15954826692915817e****\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"errorCode\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"message\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"删除应用成功\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"success\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"traceId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"0ab2646915954826692568137d****\\\\\\\\\\\\\\"}\\",\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DeleteTraceApp', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-28T11:09:19.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-03T03:18:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-22T06:57:14.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ], + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + ], + 'DeleteWebhookContact' => [ + 'summary' => 'Deletes a webhook alert contact.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'WebhookId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the webhook alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], + ], + ], 'responses' => [ 200 => [ 'schema' => [ @@ -13301,49 +9360,32 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'Code' => [ - 'description' => 'The status code or error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'IsSuccess' => ['description' => 'Indicates whether the webhook alert contact was deleted.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'UpdateEnvCustomJob', - ], - 'ListEnvCustomJobs' => [ - 'summary' => 'Queries the custom jobs of an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteWebhookContactResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteWebhookContactResponse>","errorExample":""}]', + 'title' => 'DeleteWebhookContact', + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWebhookContact'], + ], ], + 'ramActions' => [], + ], + 'DescribeAddonMetrics' => [ + 'summary' => 'Queries the metric details of a component.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13351,187 +9393,130 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the component.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql'], ], [ - 'name' => 'EnvironmentId', + 'name' => 'AddonVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The version of the component.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.1'], ], [ - 'name' => 'EncryptYaml', + 'name' => 'AliyunLang', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否返回加密后的yaml', - 'description' => 'Specifies whether to return the encrypted YAML string.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'EnvironmentType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CS'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****'], + 'Code' => ['title' => '', 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The metric details.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The data returned.'."\n", + 'description' => 'The metric details.'."\n", 'type' => 'object', 'properties' => [ - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'CustomJobName' => [ - 'description' => 'The name of the custom job.'."\n", - 'type' => 'string', - 'example' => 'job1', - ], - 'ConfigYaml' => [ - 'title' => '请求参数encryptYaml为true，则返回base64编码后的yaml串。否则返回明文yaml串。', - 'description' => 'If the request parameter EncryptYaml is set to true, a Base64-encoded YAML string is returned. Otherwise, a plaintext YAML string is returned.'."\n", - 'type' => 'string', - 'example' => 'Refer to supplementary instructions.', - ], - 'Status' => [ - 'description' => 'The status of the custom job.'."\n", - 'type' => 'string', - 'example' => 'run', - ], - 'CreationTimestamp' => [ - 'description' => 'The time when the custom job was created. The value of this parameter is a timestamp.'."\n", - 'type' => 'string', - 'example' => '2022-01-01T10:11:34Z', - ], - 'AddonName' => [ - 'title' => '归属的组件名', - 'description' => 'The name of the add-on to which the custom job belongs.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'AddonReleaseName' => [ - 'title' => '归属的组件实例名', - 'description' => 'The instance name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql1', - ], - 'AddonVersion' => [ - 'title' => '归属的组件版本', - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'example' => '1.1.0', + 'Group' => ['description' => 'The metric group.'."\n", 'type' => 'string', 'example' => 'Common', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the tag.'."\n", 'type' => 'string', 'example' => '大小为PAGE_SIZE的B树页面被成功压缩的次数。'."\n", 'title' => ''], + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'page_size', 'title' => ''], + 'Source' => ['description' => 'The source of the tag.'."\n", 'type' => 'string', 'example' => 'db', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ScrapeConfigs' => [ - 'description' => 'The capture configurations.'."\n", + 'Metrics' => [ + 'description' => 'The metrics.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'scrape config', + 'description' => 'The metrics.'."\n", 'type' => 'object', 'properties' => [ - 'JobName' => [ - 'description' => 'The name of the job.'."\n", - 'type' => 'string', - 'example' => 'custom-sd-demo', - ], - 'ScrapeInterval' => [ - 'title' => '抓取间隔', - 'description' => 'The capture interval.'."\n", - 'type' => 'string', - 'example' => '30s', - ], - 'MetricsPath' => [ - 'title' => '', - 'description' => 'The path of the metric.'."\n", - 'type' => 'string', - 'example' => '/metrics', - ], - 'ScrapeDiscoverys' => [ - 'title' => '服务发现方式列表', - 'description' => 'The service discovery methods.'."\n", + 'Description' => ['description' => 'The description of the metric.'."\n", 'type' => 'string', 'example' => '大小为PAGE_SIZE的B树页面被成功压缩的次数。'."\n", 'title' => ''], + 'Labels' => [ + 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The service discovery method.'."\n", - 'type' => 'string', - 'example' => 'static_configs', + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the tag.'."\n", 'type' => 'string', 'example' => 'PAGE_SIZE', 'title' => ''], + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'page_size', 'title' => ''], + 'Source' => ['description' => 'The source of the tag.'."\n", 'type' => 'string', 'example' => 'db', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Type' => ['description' => 'The type of the metric.'."\n", 'type' => 'string', 'example' => 'GAUGE', 'title' => ''], + 'Unit' => ['description' => 'The unit of the metric.'."\n", 'type' => 'string', 'example' => 'bytes', 'title' => ''], + 'Metric' => ['description' => 'The metric name.'."\n", 'type' => 'string', 'example' => 'mysql_exporter_collector_duration_seconds', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B6A00968-82A8-4F14-9D1B-B53827DB****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Group\\": \\"Common\\",\\n \\"Labels\\": [\\n {\\n \\"Description\\": \\"大小为PAGE_SIZE的B树页面被成功压缩的次数。\\\\n\\",\\n \\"Key\\": \\"page_size\\",\\n \\"Source\\": \\"db\\"\\n }\\n ],\\n \\"Metrics\\": [\\n {\\n \\"Description\\": \\"大小为PAGE_SIZE的B树页面被成功压缩的次数。\\\\n\\",\\n \\"Labels\\": [\\n {\\n \\"Description\\": \\"PAGE_SIZE\\",\\n \\"Key\\": \\"page_size\\",\\n \\"Source\\": \\"db\\"\\n }\\n ],\\n \\"Type\\": \\"GAUGE\\",\\n \\"Unit\\": \\"bytes\\",\\n \\"Metric\\": \\"mysql_exporter_collector_duration_seconds\\"\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'DescribeAddonMetrics', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CustomJobName\\": \\"job1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\",\\n \\"CreationTimestamp\\": \\"2022-01-01T10:11:34Z\\",\\n \\"AddonName\\": \\"mysql\\",\\n \\"AddonReleaseName\\": \\"mysql1\\",\\n \\"AddonVersion\\": \\"1.1.0\\",\\n \\"ScrapeConfigs\\": [\\n {\\n \\"JobName\\": \\"custom-sd-demo\\",\\n \\"ScrapeInterval\\": \\"30s\\",\\n \\"MetricsPath\\": \\"/metrics\\",\\n \\"ScrapeDiscoverys\\": [\\n \\"static_configs\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ListEnvCustomJobs', + 'ramActions' => [], ], - 'DescribeEnvCustomJob' => [ - 'summary' => 'Queries the details of a custom job for an environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'DescribeAddonRelease' => [ + 'summary' => 'Queries the release information of an add-on by name.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13539,357 +9524,158 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EnvironmentId', + 'name' => 'ReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxxx', - ], + 'schema' => ['description' => 'The name of the add-on release.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'agent-822567d4-2449'], ], [ - 'name' => 'CustomJobName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the custom job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob1', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EncryptYaml', + 'name' => 'EnvironmentId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否返回加密后的yaml', - 'description' => 'Specifies whether to return an encrypted YAML string.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'Response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'ID of the request.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The release information.'."\n", 'type' => 'object', 'properties' => [ - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'CustomJobName' => [ - 'description' => 'The name of the custom job.'."\n", - 'type' => 'string', - 'example' => 'customJob1', - ], - 'ConfigYaml' => [ - 'title' => '请求参数encryptYaml为true，则返回base64编码后的yaml串。否则返回明文yaml串。', - 'description' => 'If the **encryptYaml** parameter is set to `true`, a Base64-encoded YAML string is returned. Otherwise, a plaintext YAML string is returned.'."\n", - 'type' => 'string', - 'example' => 'Refer to supplementary instructions.', - ], - 'Status' => [ - 'title' => 'run、stop', - 'description' => 'The status. Valid values:'."\n" - ."\n" - .'* run'."\n" - .'* stop'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'stop' => 'stop', - 'run' => 'run', + 'Release' => [ + 'description' => 'The release information.'."\n", + 'type' => 'object', + 'properties' => [ + 'AddonName' => ['description' => 'The name of the add-on.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'AlertRuleCount' => ['description' => 'The number of alert rules.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Conditions' => [ + 'description' => 'The installation phase.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Condition information.', + 'type' => 'object', + 'properties' => [ + 'FirstTransitionTime' => ['description' => 'The first transition time.'."\n", 'type' => 'string', 'example' => '2018-01-31T14:32:19Z', 'title' => ''], + 'LastTransitionTime' => ['description' => 'The last transition time.'."\n", 'type' => 'string', 'example' => '2018-01-31T14:32:19Z', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Reason' => ['description' => 'The reason for the failure.'."\n", 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Status' => ['description' => 'The status of the phase.'."\n", 'type' => 'string', 'example' => 'True', 'title' => ''], + 'Type' => ['description' => 'The type of the phase.'."\n", 'type' => 'string', 'example' => 'Loaded', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The time when the add-on was created.'."\n", 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'DashboardCount' => ['description' => 'The number of dashboards.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExporterCount' => ['description' => 'The number of exporters.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'HaveConfig' => ['description' => 'Indicates whether the configuration is available.'."\n", 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'InstallUserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '23810923891', 'title' => ''], + 'Language' => ['description' => 'The language.'."\n", 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'ReleaseId' => ['description' => 'The release ID after installation.'."\n", 'type' => 'string', 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', 'title' => ''], + 'ReleaseName' => ['description' => 'The name of the release.'."\n", 'type' => 'string', 'example' => 'mysql-1695372983039', 'title' => ''], + 'Scene' => ['description' => 'The scenario.'."\n", 'type' => 'string', 'example' => 'database', 'title' => ''], + 'Status' => ['description' => 'The status.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the add-on was updated.'."\n", 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'UserID' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '13818734031', 'title' => ''], + 'Version' => ['description' => 'The version of the add-on.'."\n", 'type' => 'string', 'example' => '0.0.1', 'title' => ''], + 'EnvironmentId' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'example' => 'env-xxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'Managed' => ['description' => 'Indicates whether the component is fully managed.'."\n", 'type' => 'boolean', 'title' => '', 'example' => ''], ], - 'example' => 'run', + 'title' => '', + 'example' => '', ], + 'Config' => ['description' => 'The configuration information of the add-on release.'."\n", 'type' => 'string', 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', 'title' => ''], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CustomJobName\\": \\"customJob1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DescribeEnvCustomJob', - 'responseParamsDescription' => 'Sample ConfigYaml:'."\n" - ."\n" - .' scrape_configs:'."\n" - .' - job_name: job-demo1'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scrape_interval: 30s'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - .' - job_name: job-demo2'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scrape_interval: 30s'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - .' http_sd_configs:'."\n" - .' - url: 127.0.0.1:9090'."\n" - .' refresh_interval: 30s'."\n", - ], - 'DeleteEnvCustomJob' => [ - 'summary' => 'Deletes a custom job for an environment.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Release\\": {\\n \\"AddonName\\": \\"mysql\\",\\n \\"AlertRuleCount\\": 1,\\n \\"Conditions\\": [\\n {\\n \\"FirstTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"LastTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Reason\\": \\"xxxx\\",\\n \\"Status\\": \\"True\\",\\n \\"Type\\": \\"Loaded\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"DashboardCount\\": 1,\\n \\"ExporterCount\\": 2,\\n \\"HaveConfig\\": true,\\n \\"InstallUserId\\": \\"23810923891\\",\\n \\"Language\\": \\"zh\\",\\n \\"ReleaseId\\": \\"be29c093-3fd6-4fb6-9430-797030cc183a\\",\\n \\"ReleaseName\\": \\"mysql-1695372983039\\",\\n \\"Scene\\": \\"database\\",\\n \\"Status\\": \\"0\\",\\n \\"UpdateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"UserID\\": \\"13818734031\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-heyuan\\",\\n \\"Managed\\": false\\n },\\n \\"Config\\": \\"{\\\\\\"host\\\\\\":\\\\\\"mysql-service.default\\\\\\",\\\\\\"port\\\\\\":3306,\\\\\\"username\\\\\\":\\\\\\"root\\\\\\",\\\\\\"password\\\\\\":\\\\\\"roots\\\\\\"}\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeAddonRelease', + 'changeSet' => [ + ['createdAt' => '2024-01-23T08:07:33.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAddonRelease'], + ], ], + 'ramActions' => [], + 'translator' => 'manual', + ], + 'DescribeContactGroups' => [ + 'summary' => 'Queries an alert contact group.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'none', + 'abilityTreeCode' => '118624', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EnvironmentId', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['title' => '', 'description' => 'The name of the alert contact group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestGroup'], ], [ - 'name' => 'CustomJobName', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the custom job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'job1', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果描述', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - ], - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'DeleteEnvCustomJob', - ], - 'CreateEnvPodMonitor' => [ - 'summary' => 'Creates a PodMonitor for an environment.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The number of alert contact groups displayed on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'IsDetail', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to return all the alert contacts in the queried alert contact group. Valid values:'."\n" + ."\n" + .'* `false`'."\n" + .'* `true`'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], [ - 'name' => 'EnvironmentId', + 'name' => 'GroupIds', 'in' => 'query', - 'schema' => [ - 'title' => '环境实例ID', - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'env-xxxxxx', - ], + 'schema' => ['description' => 'The ID of the alert contact group.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'DryRun', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'title' => '示例：'."\n" - .'`'."\n" - .'apiVersion: "monitoring.coreos.com/v1"'."\n" - .'kind: "PodMonitor"'."\n" - .'metadata:'."\n" - .' name: "podmonitor-demo"'."\n" - .' namespace: "default"'."\n" - .' annotations:'."\n" - .' arms.prometheus.io/discovery: \'true\''."\n" - .'spec:'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: "30s"'."\n" - .' path: "/metrics"'."\n" - .' port: "tomcat-monitor"'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: "nginx2-exporter"'."\n" - .'`'."\n" - .'其中 arms.prometheus.io/discovery 必须存在，其值为“true”，表示serviceMonitor启用，否则表示停止。', - 'description' => 'The YAML configuration snippet for PodMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Refer to supplementary instructions.', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -13899,97 +9685,77 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned result, which indicates whether the operation was successful.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The objects that were returned.'."\n", 'type' => 'object', 'properties' => [ - 'MatchedMsg' => [ - 'title' => 'target匹配提示信息', - 'description' => 'Indicates whether targets are matched.'."\n", - 'type' => 'string', - 'example' => 'Match successful.', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'PodMonitorName' => [ - 'title' => '创建成功的podMonitor名称', - 'description' => 'The name of the created PodMonitor.'."\n", - 'type' => 'string', - 'example' => 'arms-admin-pm1', - ], - 'MatchedTargetCount' => [ - 'title' => '匹配出的targets数量', - 'description' => 'The number of matched targets.'."\n", - 'type' => 'string', - 'example' => '1', + 'Total' => ['title' => '', 'description' => 'The total number of alert contact groups.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of alert contact groups displayed on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'AlertContactGroups' => [ + 'title' => '', + 'description' => 'The name of the alert contact group.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactGroupId' => ['title' => '', 'description' => 'The ID of the alert contact group.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'ContactGroupName' => ['title' => '', 'description' => 'The name of the alert contact group.'."\n", 'type' => 'string', 'example' => 'TestGroup'], + 'Contacts' => [ + 'title' => '', + 'description' => 'The contact information. If the **IsDetail** parameter is set to `false`, no **contact** information is displayed.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The ID of the alert contact.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '456'], + 'ContactName' => ['title' => '', 'description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'example' => 'John Doe'], + 'Phone' => ['title' => '', 'description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'example' => '1381111****'], + 'Email' => ['title' => '', 'description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'example' => 'someone@example.com'], + 'ArmsContactId' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100117', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'ArmsContactGroupId' => ['description' => 'The ID of the alert contact group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '83261', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodMonitorName\\": \\"arms-admin-pm1\\",\\n \\"MatchedTargetCount\\": \\"1\\"\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'CreateEnvPodMonitor', - 'extraInfo' => 'ConfigYaml Example: '."\n" - .'```'."\n" - .'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: PodMonitor'."\n" - .'metadata:'."\n" - .' name: arms-admin-pm1'."\n" - .' namespace: arms-prom'."\n" - .' annotations:'."\n" - .' arms.prometheus.io/discovery: \'true\''."\n" - .'spec:'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: arms-prometheus-ack-arms-prometheus'."\n" - .' release: arms-prometheus'."\n" - .' namespaceSelector:'."\n" - .' any: true '."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: 30s'."\n" - .' targetPort: 9335'."\n" - .' path: /metrics'."\n" - .' - interval: 10s'."\n" - .' targetPort: 9335'."\n" - .' path: /metrics1'."\n" - .'```'."\n" - .'where arms.prometheus.io /discovery must exist, and its value is "true", which means serviceMonitor is enabled, otherwise it means it is stopped.', - ], - 'DescribeEnvPodMonitor' => [ - 'summary' => 'Queries the PodMonitor details of an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertContactGroups\\": [\\n {\\n \\"ContactGroupId\\": 123,\\n \\"ContactGroupName\\": \\"TestGroup\\",\\n \\"Contacts\\": [\\n {\\n \\"ContactId\\": 456,\\n \\"ContactName\\": \\"John Doe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"ArmsContactId\\": 100117\\n }\\n ],\\n \\"ArmsContactGroupId\\": 83261\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactGroupsResponse>\\n <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <AlertContactGroups>\\n <ContactGroupId>123</ContactGroupId>\\n <ContactGroupName>TestGroup</ContactGroupName>\\n <Contacts>\\n <ContactId>456</ContactId>\\n <ContactName>John Doe</ContactName>\\n <Phone>1381111****</Phone>\\n <Email>someone@example.com</Email>\\n </Contacts>\\n </AlertContactGroups>\\n </PageBean>\\n</DescribeContactGroupsResponse>","errorExample":""}]', + 'title' => 'DescribeContactGroups', + 'changeSet' => [ + ['createdAt' => '2023-04-28T08:33:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-17T08:05:35.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactGroups'], + ], ], + 'ramActions' => [], + ], + 'DescribeContacts' => [ + 'summary' => 'Queries alert contacts.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -13998,829 +9764,603 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'none', + 'abilityTreeCode' => '118543', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => 'John Doe'], ], [ - 'name' => 'EnvironmentId', + 'name' => 'Phone', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => '1381111*****'], ], [ - 'name' => 'Namespace', + 'name' => 'Email', 'in' => 'query', - 'schema' => [ - 'title' => 'podMonitor所在的命名空间', - 'description' => 'The namespace where the PodMonitor resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'arms-prom', - ], + 'schema' => ['title' => '', 'description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => 'someone@example.com'], ], [ - 'name' => 'PodMonitorName', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the PodMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms-admin-pm1', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['description' => 'The number of alert contacts to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert contact that you want to query. Separate multiple contact IDs with spaces.'."\n", 'type' => 'string', 'required' => false, 'example' => '123,321', 'title' => ''], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return redundant information.'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The objects that were returned.'."\n", 'type' => 'object', 'properties' => [ - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'PodMonitorName' => [ - 'description' => 'The name of the PodMonitor.'."\n", - 'type' => 'string', - 'example' => 'podMonitor1', - ], - 'ConfigYaml' => [ - 'description' => 'The YAML string of the PodMonitor.'."\n", - 'type' => 'string', - 'example' => 'Refer to supplementary instructions.', - ], - 'Status' => [ - 'title' => 'run、stop', - 'description' => 'The status. Valid values:'."\n" - ."\n" - .'* run'."\n" - .'* stop'."\n", - 'type' => 'string', - 'example' => 'run', + 'Total' => ['title' => '', 'description' => 'The total number of alert contacts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of alert contacts returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'AlertContacts' => [ + 'title' => '', + 'description' => 'The alert contacts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => ['title' => '', 'description' => 'The ID of the alert contact.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'ContactName' => ['title' => '', 'description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'example' => 'John Doe'], + 'Phone' => ['title' => '', 'description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'example' => '1381111****'], + 'Email' => ['title' => '', 'description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'example' => 'someone@example.com'], + 'IsVerify' => ['title' => '', 'description' => 'Indicates whether the mobile number was verified. Valid values:'."\n" + ."\n" + .'* `false`: no'."\n" + .'* `true`: yes'."\n", 'type' => 'boolean', 'example' => 'false'], + 'ReissueSendNotice' => ['title' => '', 'description' => 'The operation that you want to perform if phone calls fail to be answered. Valid values:'."\n" + ."\n" + .'* 0: No operation is performed.'."\n" + .'* 1: A phone call is made again.'."\n" + .'* 2: A text message is sent.'."\n" + .'* 3 (default value): The global default value is used.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3'], + 'IsEmailVerify' => ['description' => 'Indicates whether the email address was verified.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ArmsContactId' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '100147', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodMonitorName\\": \\"podMonitor1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DescribeEnvPodMonitor', - 'responseParamsDescription' => 'Sample ConfigYaml:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: PodMonitor'."\n" - .' metadata:'."\n" - .' name: arms-admin-pm1'."\n" - .' namespace: arms-prom'."\n" - .' annotations:'."\n" - .' arms.prometheus.io/discovery: \'true\''."\n" - .' spec:'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: arms-prometheus-ack-arms-prometheus'."\n" - .' release: arms-prometheus'."\n" - .' namespaceSelector:'."\n" - .' any: true '."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: 30s'."\n" - .' targetPort: 9335'."\n" - .' path: /metrics'."\n" - .' - interval: 10s'."\n" - .' targetPort: 9335'."\n" - .' path: /metrics1'."\n", - ], - 'ListEnvPodMonitors' => [ - 'summary' => 'Queries the PodMonitors of an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertContacts\\": [\\n {\\n \\"ContactId\\": 123,\\n \\"ContactName\\": \\"John Doe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"IsVerify\\": false,\\n \\"ReissueSendNotice\\": 3,\\n \\"IsEmailVerify\\": true,\\n \\"ArmsContactId\\": 100147\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactsResponse>\\n <RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <AlertContacts>\\n <ContactId>123</ContactId>\\n <ContactName>John Doe</ContactName>\\n <Phone>1381111****</Phone>\\n <Email>someone@example.com</Email>\\n <IsVerify>false</IsVerify>\\n </AlertContacts>\\n </PageBean>\\n</DescribeContactsResponse>","errorExample":""}]', + 'title' => 'DescribeContacts', + 'changeSet' => [ + ['createdAt' => '2023-04-28T08:33:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-17T08:05:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-17T07:45:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-24T02:41:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContacts'], + ], ], + 'ramActions' => [], + ], + 'DescribeDispatchRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', + 'operationType' => 'none', + 'abilityTreeCode' => '44446', + 'abilityTreeNodes' => ['FEATUREarmsVBCGEE'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the dispatch policy.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => '12345', 'title' => ''], ], [ - 'name' => 'EnvironmentId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The result of the operation.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'EnvironmentId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'PodMonitorName' => [ - 'description' => 'The name of the PodMonitor.'."\n", - 'type' => 'string', - 'example' => 'pm1', - ], - 'ConfigYaml' => [ - 'description' => 'The YAML configuration string.'."\n", - 'type' => 'string', - 'example' => 'Refer to supplementary instructions.', - ], - 'Status' => [ - 'description' => 'The status of the PodMonitor.'."\n", - 'type' => 'string', - 'example' => 'run', - ], - 'CreationTimestamp' => [ - 'description' => 'The time when the PodMonitor was created. The value of this parameter is a timestamp.'."\n", - 'type' => 'string', - 'example' => '2011-01-02T11:34:22Z', - ], - 'AddonName' => [ - 'title' => '归属的组件名', - 'description' => 'The name of the add-on to which the PodMonitor belongs.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'AddonReleaseName' => [ - 'title' => '归属的组件实例名', - 'description' => 'The instance name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql1', - ], - 'AddonVersion' => [ - 'title' => '归属的组件版本', - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'example' => '1.0.5', + 'RequestId' => ['description' => 'The ID of the request.', 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', 'title' => ''], + 'DispatchRule' => [ + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the dispatch policy.', 'type' => 'string', 'example' => 'Prometheus Alert', 'title' => ''], + 'IsRecover' => ['description' => 'Whether to send recovered alerts.'."\n" + .'true: send.'."\n" + .'false: do not send.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'DispatchType' => ['description' => 'Alarm handling method.'."\n" + ."\n" + .'CREATE_ALERT: Generate an alert.'."\n" + ."\n" + .'DISCARD_ALERT: Discard the alarm event, that is, no alarm.', 'type' => 'string', 'example' => 'CREATE_ALERT', 'title' => ''], + 'State' => ['description' => 'Indicates whether the dispatch policy is enabled. Valid values: '."\n" + ."\n" + .'- `true`: enabled'."\n" + .'- `false`: disabled', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the dispatch rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '10282', 'title' => ''], + 'GroupRules' => [ + 'description' => 'The information about groups.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RepeatInterval' => ['description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'GroupId' => ['description' => 'The ID of the group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'GroupWaitTime' => ['description' => 'The waiting time for grouping.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'GroupInterval' => ['description' => 'The grouping interval.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'GroupingFields' => [ + 'description' => 'The grouping fields.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The grouping field.', 'type' => 'string', 'example' => '_aliyun_arms_involvedObject_kind', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Endpoints' => [ - 'title' => 'podmonitor的podMetricsEndpoints', - 'description' => 'The endpoints of the PodMonitor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Endpoint list.', - 'type' => 'object', - 'properties' => [ - 'Port' => [ - 'description' => 'The external port.'."\n", - 'type' => 'string', - 'example' => '9182', - ], - 'TargetPort' => [ - 'description' => 'The destination port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3306', - ], - 'Path' => [ - 'description' => 'The collection path.'."\n", - 'type' => 'string', - 'example' => '/metrics', - ], - 'Interval' => [ - 'description' => 'The collection interval.'."\n", - 'type' => 'string', - 'example' => '30s', + 'title' => '', + 'example' => '', + ], + 'NotifyRules' => [ + 'description' => 'The collection of notification methods.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyObjects' => [ + 'description' => 'The collection of alert contacts.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyObjectId' => ['description' => 'The ID of the contact or contact group.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'NotifyType' => ['description' => 'The type of the alert contact. Valid values:'."\n" + ."\n" + .'- `CONTACT`: contact'."\n" + .'- `CONTACT_GROUP`: contact group', 'type' => 'string', 'example' => 'CONTACT', 'title' => ''], + 'Name' => ['description' => 'The name of the contact or contact group.', 'type' => 'string', 'example' => 'JohnDoe', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'MatchedTargetCount' => [ - 'title' => 'PodMonitor.Endpoint匹配出的target（即pod）数量', - 'description' => 'The number of pods that match the PodMonitor endpoint.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'title' => '', + 'example' => '', + ], + 'NotifyChannels' => [ + 'description' => 'The notification method Array.', + 'type' => 'array', + 'items' => ['description' => 'The notification method. Valid values:'."\n" + ."\n" + .'- `dingTalk`'."\n" + .'- `sms`'."\n" + .'- `webhook`'."\n" + .'- `email`'."\n" + .'- `wechat`', 'type' => 'string', 'example' => 'email', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LabelMatchExpressionGrid' => [ + 'description' => 'The information about the dispatch rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'LabelMatchExpressionGroups' => [ + 'description' => 'The collection of dispatch rules.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LabelMatchExpressions' => [ + 'description' => 'The collection of conditions of the dispatch rule.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag of the dispatch rule. Valid values:'."\n" + ."\n" + .'* `_aliyun_arms_userid`: user ID'."\n" + .'* `_aliyun_arms_involvedObject_kind`: type of the associated object'."\n" + .'* `_aliyun_arms_involvedObject_id`: ID of the associated object'."\n" + .'* `_aliyun_arms_involvedObject_name`: name of the associated object'."\n" + .'* `_aliyun_arms_alert_name`: alert name'."\n" + .'* `_aliyun_arms_alert_rule_id`: alert rule ID'."\n" + .'* `_aliyun_arms_alert_type`: alert type'."\n" + .'* `_aliyun_arms_alert_level`: alert severity'."\n", 'type' => 'string', 'example' => '_aliyun_arms_involvedObject_kind', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'app', 'title' => ''], + 'Operator' => ['description' => 'The operator used in the dispatch rule. Valid values:'."\n" + ."\n" + .'* `eq`: equals to.'."\n" + .'* `re`: matches a regular expression.'."\n", 'type' => 'string', 'example' => 'eq', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodMonitorName\\": \\"pm1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\",\\n \\"CreationTimestamp\\": \\"2011-01-02T11:34:22Z\\",\\n \\"AddonName\\": \\"mysql\\",\\n \\"AddonReleaseName\\": \\"mysql1\\",\\n \\"AddonVersion\\": \\"1.0.5\\",\\n \\"Endpoints\\": [\\n {\\n \\"Port\\": \\"9182\\",\\n \\"TargetPort\\": 3306,\\n \\"Path\\": \\"/metrics\\",\\n \\"Interval\\": \\"30s\\",\\n \\"MatchedTargetCount\\": 1\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ListEnvPodMonitors', - ], - 'UpdateEnvPodMonitor' => [ - 'summary' => 'Updates the PodMonitor of an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"DispatchRule\\": {\\n \\"Name\\": \\"Prometheus Alert\\",\\n \\"IsRecover\\": true,\\n \\"DispatchType\\": \\"CREATE_ALERT\\",\\n \\"State\\": \\"true\\",\\n \\"RuleId\\": 10282,\\n \\"GroupRules\\": [\\n {\\n \\"RepeatInterval\\": 20,\\n \\"GroupId\\": 1,\\n \\"GroupWaitTime\\": 10,\\n \\"GroupInterval\\": 15,\\n \\"GroupingFields\\": [\\n \\"_aliyun_arms_involvedObject_kind\\"\\n ]\\n }\\n ],\\n \\"NotifyRules\\": [\\n {\\n \\"NotifyObjects\\": [\\n {\\n \\"NotifyObjectId\\": \\"1\\",\\n \\"NotifyType\\": \\"CONTACT\\",\\n \\"Name\\": \\"JohnDoe\\"\\n }\\n ],\\n \\"NotifyChannels\\": [\\n \\"email\\"\\n ]\\n }\\n ],\\n \\"LabelMatchExpressionGrid\\": {\\n \\"LabelMatchExpressionGroups\\": [\\n {\\n \\"LabelMatchExpressions\\": [\\n {\\n \\"Key\\": \\"_aliyun_arms_involvedObject_kind\\",\\n \\"Value\\": \\"app\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDispatchRuleResponse>\\n<RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n<DispatchRule>\\n <GroupRules>\\n <GroupInterval>15</GroupInterval>\\n <GroupWaitTime>10</GroupWaitTime>\\n <GroupId>1</GroupId>\\n </GroupRules>\\n <GroupRules>\\n <GroupingFields>_aliyun_arms_involvedObject_kind</GroupingFields>\\n </GroupRules>\\n <State>true</State>\\n <RuleId>10282</RuleId>\\n <LabelMatchExpressionGrid>\\n <LabelMatchExpressionGroups>\\n <LabelMatchExpressions>\\n <Operator>eq</Operator>\\n <Value>app</Value>\\n <Key>_aliyun_arms_involvedObject_kind</Key>\\n </LabelMatchExpressions>\\n </LabelMatchExpressionGroups>\\n </LabelMatchExpressionGrid>\\n <NotifyRules>\\n <NotifyObjects>\\n <NotifyType>CONTACT</NotifyType>\\n <NotifyObjectId>1</NotifyObjectId>\\n <Name>JohnDoe</Name>\\n </NotifyObjects>\\n </NotifyRules>\\n <NotifyRules>\\n <NotifyChannels>email</NotifyChannels>\\n </NotifyRules>\\n <Name>Prometheus Alert</Name>\\n</DispatchRule>\\n</DescribeDispatchRuleResponse>","errorExample":""}]', + 'title' => 'DescribeDispatchRule', + 'summary' => 'Queries the information about a dispatch policy.', + 'description' => '当前接口已不再维护，请使用新版告警管理的ListNotificationPolicies接口查询通知策略信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-05-05T09:55:20.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DescribeEnvCustomJob' => [ + 'summary' => 'Queries the details of a custom job for an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* zh (default value): Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => 'podMonitor所在的命名空间', - 'description' => 'The namespace where the PodMonitor resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'arms-prom', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxxx', 'title' => ''], ], [ - 'name' => 'PodMonitorName', + 'name' => 'CustomJobName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the PodMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms-admin-pm1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the custom job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob1'], ], [ - 'name' => 'DryRun', + 'name' => 'EncryptYaml', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', - 'description' => 'Checks whether the format is valid and whether targets are matched.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The YAML configuration file of the ServiceMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Refer to supplementary instructions.', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to return an encrypted YAML string.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'Code' => [ - 'description' => 'The response code.'."\n" - ."\n" - .'> The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'MatchedMsg' => [ - 'title' => 'target匹配提示信息', - 'description' => 'Indicates whether targets are matched.'."\n", - 'type' => 'string', - 'example' => 'Match successful.'."\n", - ], - 'MatchedTargetCount' => [ - 'title' => '匹配出的targets数量', - 'description' => 'The number of matched targets.'."\n", + 'EnvironmentId' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'CustomJobName' => ['description' => 'The name of the custom job.'."\n", 'type' => 'string', 'example' => 'customJob1', 'title' => ''], + 'ConfigYaml' => ['title' => '', 'description' => 'If the **encryptYaml** parameter is set to `true`, a Base64-encoded YAML string is returned. Otherwise, a plaintext YAML string is returned.'."\n", 'type' => 'string', 'example' => '参见补充说明。'], + 'Status' => [ + 'title' => 'run、stop', + 'description' => 'The status. Valid values:'."\n" + ."\n" + .'* run'."\n" + .'* stop'."\n", 'type' => 'string', - 'example' => '1', + 'enumValueTitles' => ['stop' => 'stop', 'run' => 'run'], + 'example' => 'run', ], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"MatchedTargetCount\\": \\"1\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UpdateEnvPodMonitor', - 'requestParamsDescription' => 'Sample ConfigYAML:'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeEnvCustomJob', + 'responseParamsDescription' => 'Sample ConfigYaml:'."\n" ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: PodMonitor'."\n" - .' metadata:'."\n" - .' name: arms-admin-pm1'."\n" - .' namespace: arms-prom'."\n" - .' annotations:'."\n" - .' arms.prometheus.io/discovery: \'true\''."\n" - .' spec:'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: arms-prometheus-ack-arms-prometheus'."\n" - .' release: arms-prometheus'."\n" - .' namespaceSelector:'."\n" - .' any: true '."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: 30s'."\n" - .' targetPort: 9335'."\n" - .' path: /metrics'."\n" - .' - interval: 10s'."\n" - .' targetPort: 9335'."\n" - .' path: /metrics1'."\n", - ], - 'DeleteEnvPodMonitor' => [ - 'summary' => 'Deletes the PodMonitor of an environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + .' scrape_configs:'."\n" + .' - job_name: job-demo1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .' - job_name: job-demo2'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .' http_sd_configs:'."\n" + .' - url: 127.0.0.1:9090'."\n" + .' refresh_interval: 30s'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvCustomJob'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CustomJobName\\": \\"customJob1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DescribeEnvDropMetricsRule' => [ + 'summary' => 'Queries the metric drop rule for a specified environment instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxxx', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => 'podMonitor所在的命名空间', - 'description' => 'The namespace where the PodMonitor is located.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'arms-prom', - ], - ], - [ - 'name' => 'PodMonitorName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the PodMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms-admin-pm1', - ], + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'example' => 'env-xxxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response schema.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****'], + 'Code' => ['description' => 'The status code. A value of 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'title' => '操作结果描述', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'RuleName' => ['description' => 'The name of the metric drop rule.', 'type' => 'string', 'title' => '', 'example' => 'ruleName1'], + 'DropMetrics' => ['description' => 'The metrics to be dropped. Metrics are separated by line breaks.', 'type' => 'string', 'title' => '', 'example' => 'kube_pod_created'], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteEnvPodMonitor', - ], - 'CreateEnvServiceMonitor' => [ - 'summary' => 'Creates a ServiceMonitor for an environment.', - 'methods' => [ - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"RuleName\\": \\"ruleName1\\",\\n \\"DropMetrics\\": \\"kube_pod_created\\"\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + 'title' => 'DescribeEnvDropMetricsRule', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvDropMetricsRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], + ], ], + ], + 'DescribeEnvPodMonitor' => [ + 'summary' => 'Queries the PodMonitor details of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values:'."\n" - ."\n" - .'* zh (default): Chinese'."\n" - .'* en: English'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'en' => 'en', - 'zh' => 'zh', - ], - 'example' => 'zh', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '环境实例ID', - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'env-xxxxxx', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ - 'name' => 'DryRun', + 'name' => 'Namespace', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. The system checks whether the format is valid and whether targets are matched.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The namespace where the PodMonitor resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'arms-prom'], ], [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'title' => '示例：'."\n" - .'`'."\n" - .'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: ServiceMonitor'."\n" - .'metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .' annotations:'."\n" - .' arms.prometheus.io/discovery: \'true\''."\n" - .'spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n" - .'`'."\n" - .'其中 arms.prometheus.io/discovery 必须存在，其值为“true”，表示serviceMonitor启用，否则表示停止。', - 'description' => 'The YAML configuration file of the ServiceMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Refer to supplementary instructions.', - ], + 'name' => 'PodMonitorName', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The name of the PodMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms-admin-pm1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'MatchedMsg' => [ - 'title' => 'target匹配提示信息', - 'description' => 'Indicates whether targets are matched.'."\n", - 'type' => 'string', - 'example' => 'Match successful.'."\n", - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'ServiceMonitorName' => [ - 'title' => '成功创建的serviceMonitor名称', - 'description' => 'The name of the created ServiceMonitor.'."\n", - 'type' => 'string', - 'example' => 'arms-admin1', - ], - 'MatchedTargetCount' => [ - 'description' => 'The number of matched targets.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], + 'EnvironmentId' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'PodMonitorName' => ['description' => 'The name of the PodMonitor.'."\n", 'type' => 'string', 'example' => 'podMonitor1', 'title' => ''], + 'ConfigYaml' => ['description' => 'The YAML string of the PodMonitor.'."\n", 'type' => 'string', 'example' => '参见补充说明。', 'title' => ''], + 'Status' => ['title' => 'run、stop', 'description' => 'The status. Valid values:'."\n" + ."\n" + .'* run'."\n" + .'* stop'."\n", 'type' => 'string', 'example' => 'run'], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"ServiceMonitorName\\": \\"arms-admin1\\",\\n \\"MatchedTargetCount\\": 1\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'CreateEnvServiceMonitor', - 'requestParamsDescription' => 'Sample ConfigYAML:'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeEnvPodMonitor', + 'responseParamsDescription' => 'Sample ConfigYaml:'."\n" ."\n" .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: ServiceMonitor'."\n" + .' kind: PodMonitor'."\n" .' metadata:'."\n" - .' name: arms-admin1'."\n" + .' name: arms-admin-pm1'."\n" .' namespace: arms-prom'."\n" .' annotations:'."\n" .' arms.prometheus.io/discovery: \'true\''."\n" .' spec:'."\n" - .' endpoints:'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + .' release: arms-prometheus'."\n" + .' namespaceSelector:'."\n" + .' any: true '."\n" + .' podMetricsEndpoints:'."\n" .' - interval: 30s'."\n" - .' port: operator'."\n" + .' targetPort: 9335'."\n" .' path: /metrics'."\n" .' - interval: 10s'."\n" - .' port: operator1'."\n" - .' path: /metrics'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: arms-prometheus-ack-arms-prometheus'."\n" - ."\n" - .'You must specify arms.prometheus.io/discovery and set the value to true to enable the ServiceMonitor.'."\n", + .' targetPort: 9335'."\n" + .' path: /metrics1'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvPodMonitor'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodMonitorName\\": \\"podMonitor1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], 'DescribeEnvServiceMonitor' => [ 'summary' => 'Queries the ServiceMonitor details of an environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -14828,55 +10368,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => 'serviceMonitor所在的命名空间', - 'description' => 'The namespace where the ServiceMonitor resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'arms-prom', - ], + 'schema' => ['title' => '', 'description' => 'The namespace where the ServiceMonitor resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'arms-prom'], ], [ 'name' => 'ServiceMonitorName', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the ServiceMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms-admin1', - ], + 'schema' => ['title' => '', 'description' => 'The name of the ServiceMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms-admin1'], ], ], 'responses' => [ @@ -14886,71 +10398,32 @@ 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'ServiceMonitorName' => [ - 'description' => 'The name of the ServiceMonitor.'."\n", - 'type' => 'string', - 'example' => 'serviceMonitor1', - ], - 'ConfigYaml' => [ - 'description' => 'The YAML configuration file of the ServiceMonitor.'."\n", - 'type' => 'string', - 'example' => 'Refer to supplementary instructions.', - ], - 'Status' => [ - 'title' => 'run、stop', - 'description' => 'The status. Valid values:'."\n" - ."\n" - .'* run'."\n" - .'* stop'."\n", - 'type' => 'string', - 'example' => 'run', - ], + 'EnvironmentId' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'ServiceMonitorName' => ['description' => 'The name of the ServiceMonitor.'."\n", 'type' => 'string', 'example' => 'serviceMonitor1', 'title' => ''], + 'ConfigYaml' => ['description' => 'The YAML configuration file of the ServiceMonitor.'."\n", 'type' => 'string', 'example' => '参见补充说明。', 'title' => ''], + 'Status' => ['title' => 'run、stop', 'description' => 'The status. Valid values:'."\n" + ."\n" + .'* run'."\n" + .'* stop'."\n", 'type' => 'string', 'example' => 'run'], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ServiceMonitorName\\": \\"serviceMonitor1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'DescribeEnvServiceMonitor', 'responseParamsDescription' => 'Sample ConfigYAML:'."\n" ."\n" @@ -14993,17 +10466,19 @@ .' selector:'."\n" .' matchLabels:'."\n" .' app: arms-prometheus-ack-arms-prometheus'."\n", - ], - 'ListEnvServiceMonitors' => [ - 'summary' => 'Queries the ServiceMonitors of an environment.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvServiceMonitor'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"ServiceMonitorName\\": \\"serviceMonitor1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'DescribeEnvironment' => [ + 'summary' => 'Queries the details of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15011,32 +10486,17 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], ], 'responses' => [ @@ -15046,363 +10506,373 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ 'description' => 'The returned struct.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned data.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'EnvironmentId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => 'env-xxxxx', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'ServiceMonitorName' => [ - 'description' => 'The name of the ServiceMonitor.'."\n", - 'type' => 'string', - 'example' => 'sm1', - ], - 'ConfigYaml' => [ - 'description' => 'The YAML configuration string.'."\n", - 'type' => 'string', - 'example' => 'Refer to supplementary instructions.', - ], - 'Status' => [ - 'description' => 'The status of the ServiceMonitor.'."\n", - 'type' => 'string', - 'example' => 'run', - ], - 'CreationTimestamp' => [ - 'description' => 'The time when the ServiceMonitor was created. The value of this parameter is a timestamp.'."\n", - 'type' => 'string', - 'example' => '2011-10-11T22:32:11Z', - ], - 'AddonName' => [ - 'title' => '归属的组件名', - 'description' => 'The name of the add-on to which the ServiceMonitor belongs.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'AddonReleaseName' => [ - 'title' => '归属的组件实例名', - 'description' => 'The instance name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql1', - ], - 'AddonVersion' => [ - 'title' => '归属的组件版本', - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'example' => '1.1.0', - ], - 'MatchedServiceCount' => [ - 'title' => '匹配出的service数量', - 'description' => 'The number of matched services.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Endpoints' => [ - 'title' => 'ServiceMonitro的endpoints', - 'description' => 'The endpoints of the ServiceMonitor.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'List of endpoints for serviceMonitor.', - 'type' => 'object', - 'properties' => [ - 'Port' => [ - 'description' => 'The external port.'."\n", - 'type' => 'string', - 'example' => '9101', - ], - 'TargetPort' => [ - 'description' => 'The destination port.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '443', - ], - 'Path' => [ - 'description' => 'The collection path.'."\n", - 'type' => 'string', - 'example' => '/metrics', - ], - 'Interval' => [ - 'description' => 'The collection interval.'."\n", - 'type' => 'string', - 'example' => '30s', - ], - 'MatchedTargetCount' => [ - 'title' => 'servcieMonitor.Endpoint匹配出的target数量', - 'description' => 'The number of pods that match the ServiceMonitor endpoint.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'EnvironmentType' => ['description' => 'The type of the environment. Valid values:'."\n" + ."\n" + .'* CS: Container Service for Kubernetes (ACK)'."\n" + .'* ECS: Elastic Compute Service'."\n" + .'* Cloud: cloud service'."\n", 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'EnvironmentName' => ['description' => 'The environment name.'."\n", 'type' => 'string', 'example' => 'env1', 'title' => ''], + 'EnvironmentSubType' => ['description' => 'Environment subtypes:'."\n" + .'- CS: Currently supports ACK.'."\n" + .'- ECS: ECS is currently supported.'."\n" + .'- Cloud: Currently supports Cloud.', 'type' => 'string', 'example' => 'ACK', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '13002222xxxx', 'title' => ''], + 'BindResourceId' => ['description' => 'The ID of the resource associated with the environment, such as the ACK cluster ID or VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-xxxxx', 'title' => ''], + 'BindResourceType' => ['description' => 'The resource type.'."\n", 'type' => 'string', 'example' => 'ECS', 'title' => ''], + 'BindResourceStatus' => ['description' => 'The status of the resource.'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'BindResourceProfile' => ['description' => 'The profile of the resource.'."\n", 'type' => 'string', 'example' => 'Default', 'title' => ''], + 'BindVpcCidr' => ['description' => 'The VPC CIDR block.'."\n", 'type' => 'string', 'example' => '192.168.0.0/16', 'title' => ''], + 'PrometheusInstanceId' => ['title' => '', 'description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'example' => 'xxxxyyyyyzzzzz'], + 'PrometheusInstanceName' => ['title' => '', 'description' => 'The name of the Prometheus instance.'."\n", 'type' => 'string', 'example' => 'name1'], + 'GrafanaWorkspaceId' => ['title' => '', 'description' => 'The ID of the Grafana workspace.'."\n", 'type' => 'string', 'example' => 'grafana-cn-i7m2qn9xa01'], + 'GrafanaFolderUid' => ['description' => 'The unique ID of the Grafana directory.'."\n", 'type' => 'string', 'example' => 'xyz', 'title' => ''], + 'GrafanaDatasourceUid' => ['description' => 'The unique ID of the Grafana data source.'."\n", 'type' => 'string', 'example' => 'zuvw', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-8vb02uk57qbcktqcvqqqj', 'title' => ''], + 'GrafanaFolderUrl' => ['description' => 'The URL of the Grafana directory.'."\n", 'type' => 'string', 'example' => 'https://g.console.aliyun.com/dashboards/f/xxx/yyyy', 'title' => ''], + 'BindResourceStoreDuration' => ['title' => '', 'description' => 'The retention period of the resource. Unit: days.'."\n", 'type' => 'string', 'example' => '15'], + 'GrafaDataSourceName' => ['title' => '', 'description' => 'The name of the Grafana data source.'."\n", 'type' => 'string', 'example' => 'datasource1'], + 'GrafanaFolderTitle' => ['title' => '', 'description' => 'The name of the Grafana directory.'."\n", 'type' => 'string', 'example' => 'folder1'], + 'ManagedType' => [ + 'title' => '', + 'description' => 'managed type:'."\n" + .'- none: unmanaged. The default value for ACK clusters.'."\n" + .'- agent: managed agent (including KSM). The default values for ASK, ACS, and AckOne clusters.'."\n" + .'- agent-exporter: managed agent and exporters. The default value for the cloud service type.', + 'type' => 'string', + 'enumValueTitles' => ['agent' => 'managed agent', 'agent-exporter' => 'managed agent and exporter', 'none' => 'unmanaged'], + 'example' => 'none', + ], + 'FeePackage' => [ + 'title' => '', + 'description' => 'The payable resource plan. Valid values:'."\n" + ."\n" + .'* If the EnvironmentType parameter is set to CS, set the value to CS_Basic or CS_Pro.'."\n" + .'* Otherwise, leave the parameter empty.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['CS_Pro' => '', 'CS_Basic' => ''], + 'example' => 'CS_Basic', + ], + 'DbInstanceStatus' => [ + 'title' => '', + 'description' => 'The status of the database that is bound to the Prometheus instance.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* UNINSTALLING'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* INSTALLING'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* UNINSTALLED'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* RUNNING'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* MODIFYING'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", + 'type' => 'string', + 'enumValueTitles' => ['UNINSTALLING' => 'UNINSTALLING', 'INSTALLING' => 'INSTALLING', 'UNINSTALLED' => 'UNINSTALLED', 'RUNNING' => 'RUNNING', 'MODIFYING' => 'MODIFYING'], + 'example' => 'RUNNING', + ], + 'SecurityGroupId' => ['title' => '', 'description' => 'The ID of the security group associated with the environment.'."\n", 'type' => 'string', 'example' => 'sg-8vbdgmf4nraiqa9bx0jo'], + 'VswitchId' => ['title' => '', 'description' => 'The ID of the vSwitch associated with the environment.'."\n", 'type' => 'string', 'example' => 'vsw-2ze7yr3f1x8snryaioo7u'], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-aek2vezare****', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'p_运维', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"ServiceMonitorName\\": \\"sm1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\",\\n \\"CreationTimestamp\\": \\"2011-10-11T22:32:11Z\\",\\n \\"AddonName\\": \\"mysql\\",\\n \\"AddonReleaseName\\": \\"mysql1\\",\\n \\"AddonVersion\\": \\"1.1.0\\",\\n \\"MatchedServiceCount\\": 1,\\n \\"Endpoints\\": [\\n {\\n \\"Port\\": \\"9101\\",\\n \\"TargetPort\\": 443,\\n \\"Path\\": \\"/metrics\\",\\n \\"Interval\\": \\"30s\\",\\n \\"MatchedTargetCount\\": 1\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ListEnvServiceMonitors', - ], - 'UpdateEnvServiceMonitor' => [ - 'summary' => 'Updates the ServiceMonitor of an environment.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'DescribeEnvironment', + 'changeSet' => [ + ['createdAt' => '2024-07-10T02:00:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-03T01:56:34.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-28T03:15:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-19T06:40:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-28T02:25:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-29T13:20:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-11-03T07:43:44.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvironment'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"EnvironmentType\\": \\"CS\\",\\n \\"EnvironmentName\\": \\"env1\\",\\n \\"EnvironmentSubType\\": \\"ACK\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"UserId\\": \\"13002222xxxx\\",\\n \\"BindResourceId\\": \\"vpc-xxxxx\\",\\n \\"BindResourceType\\": \\"ECS\\",\\n \\"BindResourceStatus\\": \\"running\\",\\n \\"BindResourceProfile\\": \\"Default\\",\\n \\"BindVpcCidr\\": \\"192.168.0.0/16\\",\\n \\"PrometheusInstanceId\\": \\"xxxxyyyyyzzzzz\\",\\n \\"PrometheusInstanceName\\": \\"name1\\",\\n \\"GrafanaWorkspaceId\\": \\"grafana-cn-i7m2qn9xa01\\",\\n \\"GrafanaFolderUid\\": \\"xyz\\",\\n \\"GrafanaDatasourceUid\\": \\"zuvw\\",\\n \\"VpcId\\": \\"vpc-8vb02uk57qbcktqcvqqqj\\",\\n \\"GrafanaFolderUrl\\": \\"https://g.console.aliyun.com/dashboards/f/xxx/yyyy\\",\\n \\"BindResourceStoreDuration\\": \\"15\\",\\n \\"GrafaDataSourceName\\": \\"datasource1\\",\\n \\"GrafanaFolderTitle\\": \\"folder1\\",\\n \\"ManagedType\\": \\"none\\",\\n \\"FeePackage\\": \\"CS_Basic\\",\\n \\"DbInstanceStatus\\": \\"RUNNING\\",\\n \\"SecurityGroupId\\": \\"sg-8vbdgmf4nraiqa9bx0jo\\",\\n \\"VswitchId\\": \\"vsw-2ze7yr3f1x8snryaioo7u\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"user1\\",\\n \\"Value\\": \\"p_运维\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'DescribeEnvironmentFeature' => [ + 'summary' => 'Queries the details of a feature.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxx', - ], + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], [ - 'name' => 'Namespace', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'serviceMonitor所在的命名空间', - 'description' => 'The namespace where the ServiceMonitor is located.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms-prom', - ], + 'schema' => ['title' => 'region id', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ServiceMonitorName', + 'name' => 'FeatureName', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the ServiceMonitor.'."\n", + 'title' => '', + 'description' => 'The name of the feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* app-agent-pilot: App Pilot agent'."\n" + .'* arms-cmonitor: ARMS CMonitor agent'."\n" + .'* metric-agent: Prometheus agent'."\n", 'type' => 'string', 'required' => true, - 'docRequired' => true, - 'example' => 'serviceMonitor1', + 'enumValueTitles' => ['app-agent-pilot' => 'Agent of App Pilot', 'arms-cmonitor' => '', 'metric-agent' => 'Agent of Prometheus'], + 'example' => 'metric-agent', ], ], [ - 'name' => 'DryRun', + 'name' => 'AliyunLang', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The YAML configuration string.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Refer to supplementary instructions.', - ], + 'schema' => ['title' => '', 'description' => 'The language. Valid values: en and zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'MatchedMsg' => [ - 'title' => 'target匹配提示信息', - 'description' => 'Indicates whether targets are matched.'."\n", - 'type' => 'string', - 'example' => ' '."\n" - .'Match successful.'."\n", + 'Feature' => [ + 'description' => 'The installation information about the feature.'."\n", + 'type' => 'object', + 'properties' => [ + 'Alias' => ['description' => 'The alias of the feature.'."\n", 'type' => 'string', 'example' => 'Prometheus 探针', 'title' => ''], + 'Config' => [ + 'description' => 'The configuration of the feature.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{}', 'description' => 'The configuration of the feature.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the feature.'."\n", 'type' => 'string', 'example' => '以 Prometheus 采集规范采集 Metric 数据。', 'title' => ''], + 'EnvironmentId' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'Icon' => ['description' => 'The URL of the icon.'."\n", 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + 'Language' => ['description' => 'The language.'."\n", 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'LatestVersion' => ['description' => 'The latest version number.'."\n", 'type' => 'string', 'example' => '1.1.17', 'title' => ''], + 'Name' => ['description' => 'The name of the feature.'."\n", 'type' => 'string', 'example' => 'metric-agent', 'title' => ''], + 'Status' => [ + 'description' => 'The installation status of the agent.'."\n" + ."\n" + .'* Installing: The agent is being installed.'."\n" + .'* Success: The agent is installed.'."\n" + .'* Failed: The agent failed to be installed.'."\n" + .'* UnInstall: The agent is uninstalled or has not been installed.'."\n" + .'* Uninstalling: The agent is being uninstalled.'."\n" + .'* UnInstallFailed: The agent failed to be uninstalled.', + 'type' => 'string', + 'enumValueTitles' => ['UnInstall' => '', 'Failed' => '', 'Installing' => '', 'UnInstallFailed' => '', 'Success' => '', 'UnInstalling' => ''], + 'example' => 'Success', + 'title' => '', + ], + 'Version' => ['description' => 'The version number.'."\n", 'type' => 'string', 'example' => '1.1.17', 'title' => ''], + 'Managed' => ['description' => 'Indicates whether the component is fully managed.'."\n", 'type' => 'boolean', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], - 'MatchedTargetCount' => [ - 'title' => '匹配出的targets数量', - 'description' => 'The number of matched targets.'."\n", - 'type' => 'string', - 'example' => '1', + 'FeatureStatus' => [ + 'description' => 'The status of the feature.'."\n", + 'type' => 'object', + 'properties' => [ + 'FeatureContainers' => [ + 'description' => 'The containers of the feature.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Feature container information.', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => 'The container parameters.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The value of the parameter.'."\n", 'type' => 'string', 'example' => '['."\n" + .' "--port=9335",'."\n" + .' "--yaml=/etc/config/prometheusDisk/prometheus.yaml",'."\n" + .' "--chartVersion=1.1.17"'."\n" + .' ]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Image' => ['description' => 'The container image.'."\n", 'type' => 'string', 'example' => 'registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0', 'title' => ''], + 'Name' => ['description' => 'The container name.'."\n", 'type' => 'string', 'example' => 'arms-prometheus-operator', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The Kubernetes resource name of the feature.'."\n", 'type' => 'string', 'example' => 'arms-prometheus-ack-arms-prometheus', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'Status' => [ + 'description' => 'The status of the agent. Valid values:'."\n" + ."\n" + .'* Success: The agent is running.'."\n" + .'* Failed: The agent failed to run.'."\n" + .'* Not Found: The agent is not installed.'."\n", + 'type' => 'string', + 'enumValueTitles' => ['Failed' => 'Failed', 'Not Found' => 'Not Found', 'Success' => 'Success'], + 'example' => 'Success', + 'title' => '', + ], + 'SecurityGroupId' => ['description' => 'The ID of the security group.'."\n", 'type' => 'string', 'example' => 'sg-bp1gbhqh8b4dsgvopkry', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.'."\n", 'type' => 'string', 'example' => 'vsw-uf6vc2e4ytv8vv05j3u09', 'title' => ''], + 'BindResourceId' => ['description' => 'The ID of the resource.'."\n", 'type' => 'string', 'example' => 'c013823b55e4b4d6bb6b6f28682bd38a7', 'title' => ''], + 'Ips' => [ + 'description' => 'The IP address of the pod.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '10.178.176.187', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'config' => ['description' => 'The feature configurations.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"MatchedTargetCount\\": \\"1\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UpdateEnvServiceMonitor', - ], - 'DeleteEnvServiceMonitor' => [ - 'summary' => 'Deletes the ServiceMonitor of an environment.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Feature\\": {\\n \\"Alias\\": \\"Prometheus 探针\\",\\n \\"Config\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据。\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Icon\\": \\"http://xxx\\",\\n \\"Language\\": \\"zh\\",\\n \\"LatestVersion\\": \\"1.1.17\\",\\n \\"Name\\": \\"metric-agent\\",\\n \\"Status\\": \\"Success\\",\\n \\"Version\\": \\"1.1.17\\",\\n \\"Managed\\": false\\n },\\n \\"FeatureStatus\\": {\\n \\"FeatureContainers\\": [\\n {\\n \\"Args\\": [\\n \\"[\\\\n \\\\\\"--port=9335\\\\\\",\\\\n \\\\\\"--yaml=/etc/config/prometheusDisk/prometheus.yaml\\\\\\",\\\\n \\\\\\"--chartVersion=1.1.17\\\\\\"\\\\n ]\\"\\n ],\\n \\"Image\\": \\"registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0\\",\\n \\"Name\\": \\"arms-prometheus-operator\\"\\n }\\n ],\\n \\"Name\\": \\"arms-prometheus-ack-arms-prometheus\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"Status\\": \\"Success\\",\\n \\"SecurityGroupId\\": \\"sg-bp1gbhqh8b4dsgvopkry\\",\\n \\"VSwitchId\\": \\"vsw-uf6vc2e4ytv8vv05j3u09\\",\\n \\"BindResourceId\\": \\"c013823b55e4b4d6bb6b6f28682bd38a7\\",\\n \\"Ips\\": [\\n \\"10.178.176.187\\"\\n ]\\n },\\n \\"config\\": \\"{}\\"\\n }\\n}","type":"json"}]', + 'title' => 'DescribeEnvironmentFeature', + 'requestParamsDescription' => 'You can call the [**ListEnvironmentFeatures**](~~ListEnvironmentFeatures~~) operation to query the feature information.', + 'changeSet' => [ + ['createdAt' => '2025-02-27T09:36:32.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-23T02:55:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-07T08:24:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-01-23T08:07:33.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvironmentFeature'], + ], ], + ], + 'DescribeIMRobots' => [ + 'summary' => 'Queries a list of IM chatbots.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'RobotName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the IM chatbot.'."\n", 'type' => 'string', 'required' => false, 'example' => 'robot名称'], ], [ - 'name' => 'EnvironmentId', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxxxxx', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Namespace', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'title' => 'serviceMonitor所在的命名空间', - 'description' => 'The namespace where the ServiceMonitor is located.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'arms-prom', - ], + 'schema' => ['description' => 'The number of IM chatbots to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'ServiceMonitorName', + 'name' => 'RobotIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the ServiceMonitor.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms-admin1', - ], + 'schema' => ['description' => 'The chatbot IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], ], 'responses' => [ @@ -15412,49 +10882,86 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果描述', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The total number of queried IM chatbots.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of IM chatbots returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'AlertIMRobots' => [ + 'description' => 'The queried IM chatbots.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RobotId' => ['title' => '', 'description' => 'The ID of the IM chatbot.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'Type' => ['title' => '', 'description' => 'The type of the IM chatbot. Valid values:'."\n" + ."\n" + .'* `dingding`: DingTalk chatbot'."\n" + .'* `wechat`: WeCom chatbot'."\n", 'type' => 'string', 'example' => 'dingding'], + 'RobotName' => ['title' => '', 'description' => 'The name of the IM chatbot.'."\n", 'type' => 'string', 'example' => 'robot名称'], + 'RobotAddr' => ['title' => '', 'description' => 'The webhook URL of the IM chatbot.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******'], + 'DailyNoc' => ['title' => '', 'description' => 'Indicates whether daily statistics are sent. Valid values:'."\n" + ."\n" + .'* `false` (default): Daily statistics are not sent.'."\n" + .'* `true`: Daily statistics are sent.'."\n", 'type' => 'boolean', 'example' => 'true'], + 'DailyNocTime' => ['title' => '', 'description' => 'The point in time at which the daily statistics are sent. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.'."\n", 'type' => 'string', 'example' => '09:30,17:30'], + 'DingSignKey' => ['description' => 'The signature key of DingTalk. If you specify a signature key, DingTalk authentication is performed by using the signature key. If you do not specify a signature key, a whitelist is used for authentication by default. The keyword of the whitelist is **Alert**.'."\n", 'type' => 'string', 'example' => '******', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the IM chatbot was created.'."\n", 'type' => 'string', 'example' => '2023-01-16 17:21:48', 'title' => ''], + 'DispatchRules' => [ + 'description' => 'The notification policies.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => ['description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12345', 'title' => ''], + 'name' => ['description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => '通知策略测试', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'DeleteEnvServiceMonitor', - ], - 'InstallAddon' => [ - 'summary' => 'Installs an add-on.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertIMRobots\\": [\\n {\\n \\"RobotId\\": 123,\\n \\"Type\\": \\"dingding\\",\\n \\"RobotName\\": \\"robot名称\\",\\n \\"RobotAddr\\": \\"https://oapi.dingtalk.com/robot/send?access_token=e1a049121******\\",\\n \\"DailyNoc\\": true,\\n \\"DailyNocTime\\": \\"09:30,17:30\\",\\n \\"DingSignKey\\": \\"******\\",\\n \\"CreateTime\\": \\"2023-01-16 17:21:48\\",\\n \\"DispatchRules\\": [\\n {\\n \\"id\\": 12345,\\n \\"name\\": \\"通知策略测试\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DescribeIMRobots', + 'changeSet' => [ + ['createdAt' => '2024-05-09T02:03:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-17T08:05:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-21T09:10:39.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIMRobots'], + ], ], + 'ramActions' => [], + ], + 'DescribePrometheusAlertRule' => [ + 'summary' => 'Queries the details about an alert rule for a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15462,286 +10969,114 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon名称', - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysql', - ], - ], - [ - 'name' => 'AddonVersion', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon版本', - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0.0.1', - ], - ], - [ - 'name' => 'AliyunLang', - 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh|en', - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], - ], - [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], - ], - [ - 'name' => 'Values', - 'in' => 'query', - 'schema' => [ - 'title' => '输入的元数据 ', - 'description' => 'The metadata.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', - ], - ], - [ - 'name' => 'ReleaseName', + 'name' => 'AlertId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the add-on after it is installed. If you do not specify this parameter, a default rule name is generated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql-xxxxx', - ], + 'schema' => ['description' => 'The ID of the alert rule. You can call the ListPrometheusAlertRules operation to query the ID of the alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '3888704', 'title' => ''], ], [ - 'name' => 'DryRun', - 'in' => 'query', - 'schema' => [ - 'title' => '是否试运行, 默认为false', - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The returned data.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', 'title' => ''], + 'PrometheusAlertRule' => [ + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'AddonName' => [ - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'AlertRuleCount' => [ - 'description' => 'The number of alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Conditions' => [ - 'description' => 'The installation phase.'."\n", + 'Status' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'* `1`: The alert rule is enabled.'."\n" + .'* `0`: The alert rule is disabled.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The type of the alert rule.'."\n", 'type' => 'string', 'example' => 'Kubernetes组件告警', 'title' => ''], + 'NotifyType' => ['description' => 'The method of that is used to send alert notifications. Valid values:'."\n" + ."\n" + .'* `ALERT_MANAGER`: Alert notifications are sent by Operation Center.'."\n" + .'* `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.'."\n", 'type' => 'string', 'example' => 'ALERT_MANAGER', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.'."\n", 'type' => 'string', 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', 'title' => ''], + 'Message' => ['description' => 'The alert message. Tags can be referenced in the {{$labels.xxx}} format.'."\n", 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + 'Duration' => ['description' => 'The duration of the alert. Valid values: 1 to 1440. Unit: minutes.'."\n", 'type' => 'string', 'example' => '1m', 'title' => ''], + 'DispatchRuleId' => ['description' => 'The ID of the notification policy. This parameter is returned if the **NotifyType** parameter is set to `DISPATCH_RULE`.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10282', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'example' => 'Prometheus_Alert', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3888704', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags of the alert rule.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'Condition information.', 'type' => 'object', 'properties' => [ - 'FirstTransitionTime' => [ - 'description' => 'The first transition time.'."\n", - 'type' => 'string', - 'example' => '2018-01-31T14:32:19Z', - ], - 'LastTransitionTime' => [ - 'description' => 'The last transition time.'."\n", - 'type' => 'string', - 'example' => '2018-01-31T14:32:19Z', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Reason' => [ - 'description' => 'The reason for the failure.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Status' => [ - 'description' => 'The status of the phase.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Type' => [ - 'description' => 'The type of the phase.'."\n", - 'type' => 'string', - 'example' => 'Loaded', - ], + 'Name' => ['description' => 'The name of the tag.'."\n", 'type' => 'string', 'example' => 'severity', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'critical', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'CreateTime' => [ - 'description' => 'The time when the add-on was created.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'DashboardCount' => [ - 'description' => 'The number of dashboards.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExporterCount' => [ - 'description' => 'The number of exporters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'HaveConfig' => [ - 'description' => 'Indicates whether the configuration is available.'."\n", - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'InstallUserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '123456', - ], - 'Language' => [ - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'ReleaseId' => [ - 'description' => 'The release ID after installation.'."\n", - 'type' => 'string', - 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', - ], - 'ReleaseName' => [ - 'description' => 'The name of the release.'."\n", - 'type' => 'string', - 'example' => 'mysql-1695372983039', - ], - 'Scene' => [ - 'description' => 'The scenario.'."\n", - 'type' => 'string', - 'example' => 'database', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'UpdateTime' => [ - 'description' => 'The time when the add-on was updated.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '111', - ], - 'Version' => [ - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'example' => '0.0.1', - ], - 'EnvironmentId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => 'env-xxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'Managed' => [ - 'description' => 'Indicates whether the component is fully managed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Annotations' => [ + 'description' => 'The annotations of the alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the annotation.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Value' => ['description' => 'The value of the annotation.'."\n", 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AddonName\\": \\"mysql\\",\\n \\"AlertRuleCount\\": 1,\\n \\"Conditions\\": [\\n {\\n \\"FirstTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"LastTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Reason\\": \\"xxxx\\",\\n \\"Status\\": \\"True\\",\\n \\"Type\\": \\"Loaded\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"DashboardCount\\": 1,\\n \\"ExporterCount\\": 2,\\n \\"HaveConfig\\": true,\\n \\"InstallUserId\\": \\"123456\\",\\n \\"Language\\": \\"zh\\",\\n \\"ReleaseId\\": \\"be29c093-3fd6-4fb6-9430-797030cc183a\\",\\n \\"ReleaseName\\": \\"mysql-1695372983039\\",\\n \\"Scene\\": \\"database\\",\\n \\"Status\\": \\"0\\",\\n \\"UpdateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"UserId\\": \\"111\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-heyuan\\",\\n \\"Managed\\": true\\n }\\n}","type":"json"}]', - 'title' => 'InstallAddon', - ], - 'DescribeAddonRelease' => [ - 'summary' => 'Queries the release information of an add-on by name.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRule\\": {\\n \\"Status\\": 1,\\n \\"Type\\": \\"Kubernetes组件告警\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"1m\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DescribePrometheusAlertRule', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-31T01:50:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-07-14T01:39:25.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePrometheusAlertRule'], + ], ], + 'ramActions' => [], + ], + 'DescribeTraceLicenseKey' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15749,241 +11084,43 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'release的名称', - 'description' => 'The name of the add-on release.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'agent-822567d4-2449', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'Response.'."\n", + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'ID of the request.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'string', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The release information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Release' => [ - 'description' => 'The release information.'."\n", - 'type' => 'object', - 'properties' => [ - 'AddonName' => [ - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'AlertRuleCount' => [ - 'description' => 'The number of alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Conditions' => [ - 'description' => 'The installation phase.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Condition information.', - 'type' => 'object', - 'properties' => [ - 'FirstTransitionTime' => [ - 'description' => 'The first transition time.'."\n", - 'type' => 'string', - 'example' => '2018-01-31T14:32:19Z', - ], - 'LastTransitionTime' => [ - 'description' => 'The last transition time.'."\n", - 'type' => 'string', - 'example' => '2018-01-31T14:32:19Z', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Reason' => [ - 'description' => 'The reason for the failure.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Status' => [ - 'description' => 'The status of the phase.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Type' => [ - 'description' => 'The type of the phase.'."\n", - 'type' => 'string', - 'example' => 'Loaded', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the add-on was created.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'DashboardCount' => [ - 'description' => 'The number of dashboards.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExporterCount' => [ - 'description' => 'The number of exporters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'HaveConfig' => [ - 'description' => 'Indicates whether the configuration is available.'."\n", - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'InstallUserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '23810923891', - ], - 'Language' => [ - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'ReleaseId' => [ - 'description' => 'The release ID after installation.'."\n", - 'type' => 'string', - 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', - ], - 'ReleaseName' => [ - 'description' => 'The name of the release.'."\n", - 'type' => 'string', - 'example' => 'mysql-1695372983039', - ], - 'Scene' => [ - 'description' => 'The scenario.'."\n", - 'type' => 'string', - 'example' => 'database', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'UpdateTime' => [ - 'description' => 'The time when the add-on was updated.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'UserID' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '13818734031', - ], - 'Version' => [ - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'example' => '0.0.1', - ], - 'EnvironmentId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => 'env-xxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'Managed' => [ - 'description' => 'Indicates whether the component is fully managed.'."\n", - 'type' => 'boolean', - ], - ], - ], - 'Config' => [ - 'description' => 'The configuration information of the add-on release.'."\n", - 'type' => 'string', - 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', - ], - ], - ], + 'LicenseKey' => ['description' => 'The license key for the application.'."\n", 'type' => 'string', 'example' => 'b590lhguqs@3a75d95f218****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '29053944-6FE5-4240-8927-10095ECE****', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Release\\": {\\n \\"AddonName\\": \\"mysql\\",\\n \\"AlertRuleCount\\": 1,\\n \\"Conditions\\": [\\n {\\n \\"FirstTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"LastTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Reason\\": \\"xxxx\\",\\n \\"Status\\": \\"True\\",\\n \\"Type\\": \\"Loaded\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"DashboardCount\\": 1,\\n \\"ExporterCount\\": 2,\\n \\"HaveConfig\\": true,\\n \\"InstallUserId\\": \\"23810923891\\",\\n \\"Language\\": \\"zh\\",\\n \\"ReleaseId\\": \\"be29c093-3fd6-4fb6-9430-797030cc183a\\",\\n \\"ReleaseName\\": \\"mysql-1695372983039\\",\\n \\"Scene\\": \\"database\\",\\n \\"Status\\": \\"0\\",\\n \\"UpdateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"UserID\\": \\"13818734031\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-heyuan\\",\\n \\"Managed\\": true\\n },\\n \\"Config\\": \\"{\\\\\\"host\\\\\\":\\\\\\"mysql-service.default\\\\\\",\\\\\\"port\\\\\\":3306,\\\\\\"username\\\\\\":\\\\\\"root\\\\\\",\\\\\\"password\\\\\\":\\\\\\"roots\\\\\\"}\\"\\n }\\n}","type":"json"}]', - 'title' => 'DescribeAddonRelease', - ], - 'ListAddons' => [ - 'summary' => 'List of access center products.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"LicenseKey\\": \\"b590lhguqs@3a75d95f218****\\",\\n \\"RequestId\\": \\"29053944-6FE5-4240-8927-10095ECE****\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribeTraceLicenseKeyResponse>\\n <LicenseKey>b590lhguqs@3a75d95f218****</LicenseKey>\\n <RequestId>29053944-6FE5-4240-8927-10095ECE****</RequestId>\\n</DescribeTraceLicenseKeyResponse>","errorExample":""}]', + 'title' => 'DescribeTraceLicenseKey', + 'summary' => 'Queries the license key.', + 'changeSet' => [ + ['createdAt' => '2022-11-17T02:42:45.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'DescribeWebhookContacts' => [ + 'summary' => 'Queries the list of webhook alert contacts.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -15993,438 +11130,537 @@ 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'abilityTreeCode' => '118619', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Search', + 'name' => 'WebhookName', 'in' => 'query', - 'schema' => [ - 'title' => '查询参数', - 'description' => 'A query field can be queried by name or description.', - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['title' => '', 'description' => 'The name of the webhook alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => 'webhook名称'], ], [ - 'name' => 'Regexp', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", - 'description' => 'Whether to enable regular matching.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境,默认为中文 zh | en', - 'description' => 'Language,the default language is Chinese.', - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The number of alert contacts displayed on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], [ - 'name' => 'Category', + 'name' => 'ContactIds', 'in' => 'query', - 'schema' => [ - 'title' => '标签筛选', - 'description' => 'Category filter.', - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], + 'schema' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'title' => '状态码, 200为正常, 其他为异常', - 'description' => 'Status code: 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'title' => '提示消息', - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'title' => '业务是否成功', - 'description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" - ."\n" - .'* `true`: The alert rule was deleted.'."\n" - .'* `false`: The alert rule failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The queried add-ons.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the add-on.'."\n", - 'type' => 'object', - 'properties' => [ - 'Alias' => [ - 'description' => 'The alias of the add-on.'."\n", - 'type' => 'string', - 'example' => 'MySQL', - ], - 'Categories' => [ - 'description' => 'The tags of the add-on.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => 'cloud', - ], - ], - 'Dashboards' => [ - 'description' => 'The dashboards.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Dashboard details.', - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'description' => 'The description of the dashboard.'."\n", - 'type' => 'string', - 'example' => 'MySQL monitors the market information, monitoring the connection information, usage information and other indicators', - ], - 'Name' => [ - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'example' => 'mysql-overview', - ], - 'Url' => [ - 'description' => 'The URL of the dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', - ], - ], - ], - ], - 'Description' => [ - 'description' => 'The description of the add-on.'."\n", - 'type' => 'string', - 'example' => 'Monitor database indicators with MySQL Exporter', - ], - 'Environments' => [ - 'description' => 'The supported environments.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the environment.'."\n", - 'type' => 'object', - 'properties' => [ - 'Dependencies' => [ - 'description' => 'The dependencies of the environment.'."\n", - 'type' => 'object', - 'properties' => [ - 'Features' => [ - 'description' => 'The feature on which the environment depends.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the feature is supported.'."\n", - 'example' => 'true', - ], - ], - 'Services' => [ - 'description' => 'The services.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'ResourceCenter', - ], - ], - 'ClusterTypes' => [ - 'description' => 'The supported cluster types.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The cluster type.'."\n", - 'type' => 'string', - 'example' => 'ManagedKubernetes/Serverless', - ], - ], - ], - ], - 'Description' => [ - 'description' => 'The description of the environment.'."\n", - 'type' => 'string', - 'example' => 'The MySQL service is deployed in a Kubernetes cluster.', - ], - 'Enable' => [ - 'description' => 'Indicates whether the feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Label' => [ - 'description' => 'The tag of the environment.'."\n", - 'type' => 'string', - 'example' => 'Container', - ], - 'Name' => [ - 'description' => 'The name of the environment.'."\n", - 'type' => 'string', - 'example' => 'CS', - ], - 'Policies' => [ - 'description' => 'The control policies in the environment.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlertDefaultStatus' => [ - 'description' => 'The default alert status.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'DefaultInstall' => [ - 'description' => 'The default installation status.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'TargetAddonName' => [ - 'description' => 'The target name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'cloud-rds-mysql', - ], - 'Protocols' => [ - 'description' => 'The supported protocols.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'Protocol details.', - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the protocol.'."\n", - 'type' => 'string', - 'example' => 'arms', - ], - 'Label' => [ - 'description' => 'The tag of the protocol.'."\n", - 'type' => 'string', - 'example' => 'ARMS', - ], - 'Icon' => [ - 'description' => 'The URL of the protocol icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'Description' => [ - 'description' => 'The description of the protocol.'."\n", - 'type' => 'string', - 'example' => 'ARMS', - ], - ], - ], - ], - 'EnableServiceAccount' => [ - 'description' => 'Indicates whether a service account is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false.', - ], - 'NeedRestartAfterIntegration' => [ - 'description' => 'Indicates whether a restart is required after the installation.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'MetricCheckRule' => [ - 'description' => 'The metric check rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'PromQL' => [ - 'description' => 'The PromQL statements.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'PromQL statements are supported.'."\n", - 'type' => 'string', - 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The total number of alert contacts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of alert contacts displayed on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'WebhookContacts' => [ + 'title' => '', + 'description' => 'The list of webhook alert contacts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WebhookId' => ['title' => '', 'description' => 'The ID of the webhook alert contact.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '123'], + 'WebhookName' => ['title' => '', 'description' => 'The name of the webhook alert contact.'."\n", 'type' => 'string', 'example' => 'webhook名称'], + 'Webhook' => [ + 'title' => '', + 'description' => 'The details of the webhook alert contact.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => ['title' => '', 'description' => 'The HTTP request method.'."\n" + ."\n" + .'* Get'."\n" + .'* Post'."\n", 'type' => 'string', 'example' => 'Post'], + 'Url' => ['title' => 'Url', 'description' => 'The URL of the request method.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****'], + 'BizHeaders' => ['title' => '', 'description' => 'The header of the HTTP request.'."\n", 'type' => 'object', 'example' => '[{"Content-Type":"application/json"}]'], + 'BizParams' => ['title' => '', 'description' => 'The parameters in the HTTP request.'."\n", 'type' => 'object', 'example' => '[{"content:"mike"}]'], + 'Body' => ['title' => '', 'description' => 'The alert notification template.'."\n", 'type' => 'string', 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "告警时间":"{{ .startTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'], + 'RecoverBody' => ['title' => '', 'description' => 'The notification template for clearing alerts.'."\n", 'type' => 'string', 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "恢复时间":"{{ .endTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'], ], + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'Icon' => [ - 'description' => 'The URL of the icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', - ], - 'Keywords' => [ - 'description' => 'The collection of keywords.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'example' => 'Java', - ], - ], - 'Language' => [ - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'Name' => [ - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'Once' => [ - 'description' => 'Indicates whether the add-on can be installed only once.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Scene' => [ - 'description' => 'The scenario.'."\n", - 'type' => 'string', - 'example' => 'database', - ], - 'Version' => [ - 'description' => 'The version of the agent.'."\n", - 'type' => 'string', - 'example' => '0.0.1', - ], - 'Weight' => [ - 'description' => 'The weight.'."\n", - 'type' => 'string', - 'example' => '857', - ], - 'LatestReleaseCreateTime' => [ - 'description' => 'The time when the instance was last created.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Alias\\": \\"MySQL\\",\\n \\"Categories\\": [\\n \\"cloud\\"\\n ],\\n \\"Dashboards\\": [\\n {\\n \\"Description\\": \\"MySQL监控大盘信息，监控了连接信息、使用信息等指标\\",\\n \\"Name\\": \\"mysql-overview\\",\\n \\"Url\\": \\"http://xxxx\\"\\n }\\n ],\\n \\"Description\\": \\"通过 MySQL Exporter 监控数据库指标\\",\\n \\"Environments\\": [\\n {\\n \\"Dependencies\\": {\\n \\"Features\\": {\\n \\"key\\": true\\n },\\n \\"Services\\": [\\n \\"ResourceCenter\\"\\n ],\\n \\"ClusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ]\\n },\\n \\"Description\\": \\"MySQL 服务部署在 Kubernetes 集群中。\\",\\n \\"Enable\\": true,\\n \\"Label\\": \\"容器环境\\",\\n \\"Name\\": \\"CS\\",\\n \\"Policies\\": {\\n \\"AlertDefaultStatus\\": \\"default\\",\\n \\"DefaultInstall\\": false,\\n \\"TargetAddonName\\": \\"cloud-rds-mysql\\",\\n \\"Protocols\\": [\\n {\\n \\"Name\\": \\"arms\\",\\n \\"Label\\": \\"ARMS\\",\\n \\"Icon\\": \\"http://xxxxxxx\\",\\n \\"Description\\": \\"ARMS\\"\\n }\\n ],\\n \\"EnableServiceAccount\\": true,\\n \\"NeedRestartAfterIntegration\\": true,\\n \\"MetricCheckRule\\": {\\n \\"PromQL\\": [\\n \\"scraper_up{scraper=\\\\\\\\\\\\\\"ecs\\\\\\\\\\\\\\"}==1\\"\\n ]\\n }\\n }\\n }\\n ],\\n \\"Icon\\": \\"http://xxxx\\",\\n \\"Keywords\\": [\\n \\"Java\\"\\n ],\\n \\"Language\\": \\"zh\\",\\n \\"Name\\": \\"mysql\\",\\n \\"Once\\": false,\\n \\"Scene\\": \\"database\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"Weight\\": \\"857\\",\\n \\"LatestReleaseCreateTime\\": \\"2023-09-22T16:56:29+08:00\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListAddons', - ], - 'UpgradeAddonRelease' => [ - 'summary' => 'Updates the release information of an add-on.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"WebhookContacts\\": [\\n {\\n \\"WebhookId\\": 123,\\n \\"WebhookName\\": \\"webhook名称\\",\\n \\"Webhook\\": {\\n \\"Method\\": \\"Post\\",\\n \\"Url\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f6****\\",\\n \\"BizHeaders\\": [\\n {\\n \\"Content-Type\\": \\"application/json\\"\\n }\\n ],\\n \\"BizParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Body\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"告警时间\\\\\\":\\\\\\"{{ .startTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\",\\n \\"RecoverBody\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"恢复时间\\\\\\":\\\\\\"{{ .endTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'DescribeWebhookContacts', + 'changeSet' => [ + ['createdAt' => '2022-11-17T08:05:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-07T10:38:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWebhookContacts'], + ], ], + 'ramActions' => [], + ], + 'DoInsightsAction' => [ + 'summary' => 'Executes the corresponding action based on the module type specified by the parameter.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '227392', + 'abilityTreeNodes' => ['FEATUREarmsXHEL9X'], ], 'parameters' => [ [ - 'name' => 'AddonVersion', - 'in' => 'query', + 'name' => 'Module', + 'in' => 'formData', 'schema' => [ - 'title' => 'addon的版本信息', - 'description' => 'The version of the add-on.'."\n", + 'description' => 'Module type'."\n" + .'- QueryTopo '."\n" + .' '."\n" + .' Topology query feature. A topology consists of edges and nodes. Each edge has a corresponding type, each node has a corresponding entity, and each entity has its type. By setting the edge type, node type, query time range, and other filter parameters, you can filter out the required topology data.'."\n" + ."\n" + .'- QueryTopoRed'."\n" + .' '."\n" + .' Topology RED metrics (request count, latency, error count) query. When querying a topology with the metrics query option enabled, the topology may be too large to retrieve all metrics data. This feature allows users to actively query metrics data for specified nodes and edges.'."\n" + ."\n\n" + .'Note: The above features are in canary release and are not enabled by default. To enable them, please contact ARMS on-call support.', + 'enumValueTitles' => ['QueryTopoRed' => 'Topology RED metrics query', 'QueryTopo' => 'Topology query'], 'type' => 'string', 'required' => true, - 'example' => '0.0.2', + 'docRequired' => true, + 'example' => 'QueryTopo', + 'title' => '', ], ], [ - 'name' => 'Values', - 'in' => 'query', - 'schema' => [ - 'title' => '元数据信息', - 'description' => 'The metadata information.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', - ], + 'name' => 'Data', + 'in' => 'formData', + 'schema' => ['description' => 'Query parameters. The query parameters vary depending on the module type.'."\n" + ."\n" + .'- QueryTopo'."\n" + .'```'."\n" + .'{'."\n" + .' "regionId": string, #Region ID'."\n" + .' "startTime": string, #Start time in the format of yyyy-MM-dd HH:mm:ss'."\n" + .' "endTime": string, #End time in the format of yyyy-MM-dd HH:mm:ss'."\n" + .' "edgeFilter": { #Edge filter conditions'."\n" + .' "includeTypes": [enum], #Edge types to include'."\n" + .' "excludeTypes": [enum], #Edge types to exclude'."\n" + .' "fromNodeFilter": { #Source node filter conditions'."\n" + .' "includeEntityTypes": [enum] #Entity types to include'."\n" + .' "excludeEntityTypes": [enum] #Entity types to exclude'."\n" + .' },'."\n" + .' "toNodeFilter": { #Target node filter conditions'."\n" + .' "includeEntityTypes": [enum] #Entity types to include'."\n" + .' "excludeEntityTypes": [enum] #Entity types to exclude'."\n" + .' }'."\n" + .' },'."\n" + .' "includeIsolatedNodes": boolean, #Whether to include isolated nodes'."\n" + .' "isolatedNodeFilter": { # Isolated node filter conditions'."\n" + .' "includeEntityTypes": [enum] #Entity types to include'."\n" + .' "excludeEntityTypes": [enum] #Entity types to exclude'."\n" + .' },'."\n" + .' "queryMetrics": boolean, # Whether to synchronously query related RED metrics when querying topology'."\n" + .' "timeoutSecs": int, # Metrics query timeout in seconds'."\n" + .' "redOption": { #Metrics query control options'."\n" + .' "skipRt": boolean, # Whether to skip querying RT metrics'."\n" + .' "skipCount": boolean, # Whether to skip querying request count metrics'."\n" + .' "skipError": boolean # Whether to skip querying error count metrics'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + ."\n" + .'- QueryTopoRed'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "regionId": string, #Region ID'."\n" + .' "startTime": string, #Start time in the format of yyyy-MM-dd HH:mm:ss'."\n" + .' "endTime": string, #End time in the format of yyyy-MM-dd HH:mm:ss'."\n" + .' "edgeIds": [string] #Edge IDs to query'."\n" + .' "nodeIds": [string] #Node IDs to query'."\n" + .' "redOption": { #Metrics query control options'."\n" + .' "skipRt": boolean, # Whether to skip querying RT metrics'."\n" + .' "skipCount": boolean, # Whether to skip querying request count metrics'."\n" + .' "skipError": boolean # Whether to skip querying error count metrics'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'```', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => "\n" + ."\n" + .'- QueryTopo'."\n" + ."\n\n" + .' {'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "startTime": "2024-07-23 19:16:00", '."\n" + .' "endTime": "2024-07-23 20:16:00", # 限定拓扑查询范围为 2024-07-23 19:16:00至2024-07-23 20:16:00'."\n" + .' "edgeFilter": {'."\n" + .' "includeTypes": ['."\n" + .' "CALLS" # 限定结果拓扑中仅包含调用关系的边'."\n" + .' ],'."\n" + .' "fromNodeFilter": {'."\n" + .' "includeEntityTypes": [ # 限定调用边的源节点类型必须为应用类型'."\n" + .' "APPLICATION" '."\n" + .' ]'."\n" + .' },'."\n" + .' "toNodeFilter": {'."\n" + .' "includeEntityTypes": [ # 限定调用边的目标节点必须为应用类型或者外部服务类型'."\n" + .' "APPLICATION",'."\n" + .' "EXTERNAL_SERVICE"'."\n" + .' ]'."\n" + .' }'."\n" + .' },'."\n" + .' "includeIsolatedNodes": false, # 结果拓扑中不包含孤立节点'."\n" + .' "queryMetrics": true, # 同步查询RED指标'."\n" + .' "timeoutSecs": 20, #最多用20秒来查询指标数据'."\n" + .' "redOption": { # 查询的指标包括耗时、请求量，跳过错误数的查询'."\n" + .' "skipRt": false,'."\n" + .' "skipCount": false,'."\n" + .' "skipError": true'."\n" + .' }'."\n" + .' }'."\n" + ."\n\n" + ."\n" + .'- QueryTopoRed'."\n" + ."\n\n" + .' {'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "startTime": "2024-07-23 10:00:00",'."\n" + .' "endTime": "2024-07-23 14:00:00",'."\n" + .' "edgeIds": ['."\n" + .' "097843bd50b06fbe2c6c1d8b761a7e8b"'."\n" + .' ],'."\n" + .' "nodeIds": ['."\n" + .' "23d973261c6923da1b5b7a571ec1aa8b"'."\n" + .' ],'."\n" + .' "redOption": { # 查询的指标包括耗时、请求量，跳过错误数的查询'."\n" + .' "skipCount": false,'."\n" + .' "skipError": true,'."\n" + .' "skipRt": false'."\n" + .' }'."\n" + .' }'."\n" + ."\n", 'title' => ''], ], [ - 'name' => 'ReleaseName', + 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'Region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'release的名称', - 'description' => 'The name of the release.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'mysql-1695372983039', + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797A64E'], + 'Code' => ['description' => 'Status code. 200 indicates success; other status codes indicate exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Whether the query is successful:'."\n" + ."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned when the call fails.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The return parameter type is related to the module value passed in.'."\n" + ."\n" + .'- QueryTopo'."\n" + .' ```'."\n" + .' {'."\n" + .' "nodes": [Object] #Node collection. See the Node definition in the supplementary description of return parameters.'."\n" + .' "edges": [Object] #Edge collection. See the Edge definition in the supplementary description of return parameters.'."\n" + .' }'."\n" + .' ```'."\n" + .'- QueryTopoRed'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' "nodeRed": {'."\n" + .' "nodeId": {'."\n" + .' "count": double, #Total number of requests during the query period'."\n" + .' "error": double, #Total number of errors during the query period'."\n" + .' "rt": double, #Average latency during the query period, in milliseconds'."\n" + .' }'."\n" + .' },'."\n" + .' "edgeRed": {'."\n" + .' "edgeId": {'."\n" + .' "count": double, #Total number of requests during the query period'."\n" + .' "error": double, #Total number of errors during the query period'."\n" + .' "rt": double, #Average latency during the query period, in milliseconds'."\n" + .' }'."\n" + .' }'."\n" + .'}'."\n" + .' ```', 'type' => 'string', 'example' => '- QueryTopo'."\n" + ."\n\n" + .' {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "nodeId": "3bfe1a747389273388182760406c079d",'."\n" + .' "entity": {'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "appType": "TRACE",'."\n" + .' "appId": "xxxxxxxxxxxxxxxx",'."\n" + .' "name": "prometheus-pop-cn-hangzhou",'."\n" + .' "entityId": "3bfe1a747389273388182760406c079d",'."\n" + .' "firstSeenTms": 1721733226981,'."\n" + .' "lastSeenTms": 1721789171614,'."\n" + .' "type": "APPLICATION"'."\n" + .' },'."\n" + .' "attrs": {'."\n" + .' "RED": {'."\n" + .' "count": 643848.0,'."\n" + .' "error": 0.0,'."\n" + .' "rt": 172.31701892372112'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ],'."\n" + .' "edges": ['."\n" + .' {'."\n" + .' "from": "98b4184b22e588cf86e9a29aa4179606",'."\n" + .' "to": "98b4184b22e588cf86e9a29aa4179606",'."\n" + .' "type": "CALLS",'."\n" + .' "attrs": {'."\n" + .' "RED": {'."\n" + .' "count": 4.0,'."\n" + .' "error": 0.0,'."\n" + .' "rt": 37.0'."\n" + .' }'."\n" + .' },'."\n" + .' "edgeId": "5d611597e4b0013d0947615c9eca4de6",'."\n" + .' "firstSeenTms": 1721783795125,'."\n" + .' "lastSeenTms": 1721787371614'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + ."\n\n" + .'- QueryTopoRed'."\n" + ."\n" + .' {'."\n" + .' "nodeRed": {'."\n" + .' "361d9f32e58cef316bf2355f3ff05575": {'."\n" + .' "count": 3258110.0,'."\n" + .' "error": 74.0,'."\n" + .' "rt": 167.39844355494878'."\n" + .' }'."\n" + .' },'."\n" + .' "edgeRed": {}'."\n" + .' }'."\n" + ."\n", 'title' => ''], + ], + 'example' => '', + ], + ], + ], + 'title' => 'Access various sub-features related to Insights', + 'requestParamsDescription' => 'A topology consists of edges and nodes. Each edge has a corresponding type, each node has a corresponding entity, and each entity has its type. By setting the edge type, node type, query time range, and other parameters, you can filter out the required topology data.'."\n" + ."\n\n" + .'- Isolated nodes'."\n" + ."\n" + .' An isolated node refers to a node that has no relationships with other nodes.'."\n" + ."\n" + .'When a field type is enum, it indicates that the value of the field comes from an enumeration. See the supplementary description for enumeration definitions.', + 'responseParamsDescription' => '- Node definition'."\n" + .' '."\n" + .' ```'."\n" + .' {'."\n" + .' "nodeId": string, #Node ID'."\n" + .' "entity": Object, #Entity information. Fields vary depending on the type. See Entity information in the supplementary description.'."\n" + .' "attrs": { #Extended attribute information '."\n" + .' "RED": { # RED metrics'."\n" + .' "count": double, #Total number of requests during the query period'."\n" + .' "error": double, #Total number of errors during the query period'."\n" + .' "rt": double, # Average latency during the query period, in milliseconds'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ```'."\n" + ."\n\n" + .'- Edge definition'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' "from": string, #Node ID'."\n" + .' "to": string, #Node ID'."\n" + .' "type": enum, #See Edge types in the supplementary description'."\n" + .' "attrs": { #Extended attribute information'."\n" + .' "RED": { # RED metrics'."\n" + .' "count": double, #Total number of requests during the query period'."\n" + .' "error": double, #Total number of errors during the query period'."\n" + .' "rt": double, #Average latency during the query period, in milliseconds'."\n" + .' }'."\n" + .' },'."\n" + .' "edgeId": string, #Edge ID'."\n" + .' "firstSeenTms": long, #Timestamp in milliseconds when the edge was first discovered'."\n" + .' "lastSeenTms": long, #Timestamp in milliseconds when the edge was last discovered'."\n" + .' }'."\n" + ."\n" + .' ```', + 'extraInfo' => '- Entity types'."\n" + .' '."\n" + .' - APPLICATION: Application entity, i.e., a regular application'."\n" + .' - RPC: Interface entity'."\n" + .' - EXTERNAL_SERVICE: External service. All services that are not observable by APM, such as database services and Redis services.'."\n" + .' - APPLICATION_INST: Application instance entity, i.e., a specific instance running the application'."\n" + ."\n" + .'- Edge types'."\n" + ."\n" + .' - CALLS: Indicates that the entity of the source node calls the entity of the target node'."\n" + ."\n" + .' - CONTAINS: Indicates that the entity of the source node contains the entity of the target node'."\n" + ."\n" + .' - RUNS_ON: Indicates that the entity of the source node runs on the entity of the target node'."\n" + ."\n\n" + ."\n" + .'- Entities'."\n" + ."\n" + .' - APPLICATION '."\n" + .' - entityId string #Entity ID'."\n" + .' - firstSeenTms long #Timestamp in milliseconds when the entity was first discovered'."\n" + .' - lastSeenTms: long #Timestamp in milliseconds when the entity was last discovered'."\n" + .' - type enum # Entity type, value is APPLICATION'."\n" + .' - regionId string # Region where the application is deployed'."\n" + .' - appType enum # Application type'."\n" + .' - appId string # Application ID'."\n" + .' - name string # Application name'."\n" + ."\n" + .' - RPC'."\n" + .' - entityId string #Entity ID'."\n" + .' - firstSeenTms long #Timestamp in milliseconds when the entity was first discovered'."\n" + .' - lastSeenTms: long #Timestamp in milliseconds when the entity was last discovered'."\n" + .' - type enum # Entity type, value is RPC'."\n" + .' - regionId string # Region where the application is deployed'."\n" + .' - appType enum # Application type of the interface\'s parent application'."\n" + .' - appId string # Application ID of the interface\'s parent application'."\n" + .' - appName string #Application name of the interface\'s parent application'."\n" + .' - rpcType enum #Interface type'."\n" + .' - rpc string #Interface name'."\n" + ."\n" + .' - ExternalService'."\n" + ."\n" + .' - entityId string #Entity ID'."\n" + .' - firstSeenTms long #Timestamp in milliseconds when the entity was first discovered'."\n" + .' - lastSeenTms: long #Timestamp in milliseconds when the entity was last discovered'."\n" + .' - type enum # Entity type, value is EXTERNAL_SERVICE'."\n" + .' - rpcType enum #Service type'."\n" + .' - serverAddr string #Service address'."\n" + .' '."\n" + .' - ApplicationInstance'."\n" + ."\n" + .' - entityId string #Entity ID'."\n" + .' - firstSeenTms long #Timestamp in milliseconds when the entity was first discovered'."\n" + .' - lastSeenTms: long #Timestamp in milliseconds when the entity was last discovered'."\n" + .' - type enum # Entity type, value is APPLICATION_INST'."\n" + .' - regionId string # Region where the instance is deployed'."\n" + .' - appType enum # Application type'."\n" + .' - appId string # Application ID'."\n" + .' - appName string Application name'."\n" + .' - ip string #Instance IP'."\n" + .' - agentInfo Object # Instance metadata'."\n" + ."\n" + .'- Application types'."\n" + ."\n" + .' - RUM: Frontend application'."\n" + .' - XTRACE: Application instrumented through OpenTelemetry agent'."\n" + .' - TRACE: Application instrumented through ARMS agent'."\n" + .' - EBPF: Application instrumented through eBPF agent'."\n" + ."\n" + .'- Interface types'."\n" + .' '."\n" + .' To be supplemented'."\n" + ."\n" + .'- External service types'."\n" + .' '."\n" + .' To be supplemented'."\n" + ."\n" + .'- Instance metadata'."\n" + ."\n" + .' To be supplemented', + 'changeSet' => [ + ['createdAt' => '2025-01-03T09:28:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-31T03:42:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-30T09:07:36.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DoInsightsAction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797A64E\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"- QueryTopo\\\\n\\\\n\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"nodes\\\\\\": [\\\\n\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"nodeId\\\\\\": \\\\\\"3bfe1a747389273388182760406c079d\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"entity\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"appType\\\\\\": \\\\\\"TRACE\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"appId\\\\\\": \\\\\\"xxxxxxxxxxxxxxxx\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"name\\\\\\": \\\\\\"prometheus-pop-cn-hangzhou\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"entityId\\\\\\": \\\\\\"3bfe1a747389273388182760406c079d\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"firstSeenTms\\\\\\": 1721733226981,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"lastSeenTms\\\\\\": 1721789171614,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"APPLICATION\\\\\\"\\\\n\\\\t\\\\t\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"attrs\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"RED\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"count\\\\\\": 643848.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"error\\\\\\": 0.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"rt\\\\\\": 172.31701892372112\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t],\\\\n\\\\t\\\\t\\\\\\"edges\\\\\\": [\\\\n\\\\t\\\\t\\\\t{\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"from\\\\\\": \\\\\\"98b4184b22e588cf86e9a29aa4179606\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"to\\\\\\": \\\\\\"98b4184b22e588cf86e9a29aa4179606\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"type\\\\\\": \\\\\\"CALLS\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"attrs\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"RED\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"count\\\\\\": 4.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"error\\\\\\": 0.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t\\\\t\\\\\\"rt\\\\\\": 37.0\\\\n\\\\t\\\\t\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"edgeId\\\\\\": \\\\\\"5d611597e4b0013d0947615c9eca4de6\\\\\\",\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"firstSeenTms\\\\\\": 1721783795125,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"lastSeenTms\\\\\\": 1721787371614\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t]\\\\n\\\\t}\\\\n\\\\n\\\\n- QueryTopoRed\\\\n\\\\n\\\\t{\\\\n\\\\t\\\\t\\\\\\"nodeRed\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\\\"361d9f32e58cef316bf2355f3ff05575\\\\\\": {\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"count\\\\\\": 3258110.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"error\\\\\\": 74.0,\\\\n\\\\t\\\\t\\\\t\\\\t\\\\\\"rt\\\\\\": 167.39844355494878\\\\n\\\\t\\\\t\\\\t}\\\\n\\\\t\\\\t},\\\\n\\\\t\\\\t\\\\\\"edgeRed\\\\\\": {}\\\\n\\\\t}\\\\n\\\\n\\"\\n}","type":"json"}]', + ], + 'EnableMetric' => [ + 'summary' => 'Enables a discarded metric.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DryRun', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'Specifies whether to perform only a dry run, without performing the actual request.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'ccfa5e34a5c1f4ce6b916a40a12151d88', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'EnvironmentId', + 'name' => 'DropMetric', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The metric name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'kube_pod_container_status_ready', 'title' => ''], ], ], 'responses' => [ @@ -16434,318 +11670,77 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - 'Code' => [ - 'description' => 'The status code. 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.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message returned if the request parameters are invalid.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '0231DA4B-3D11-5433-9376-3B5B46C7228D'], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned struct.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'EnableMetric', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetric'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UpgradeAddonRelease', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0231DA4B-3D11-5433-9376-3B5B46C7228D\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ListAddonReleases' => [ - 'summary' => 'Queries the add-ons installed in an environment.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAgentDownloadUrl' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '191179', - 'abilityTreeNodes' => [ - 'FEATUREarms7LDEBN', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '安装环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], - ], - [ - 'name' => 'AddonName', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon的name信息', - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The result returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Releases' => [ - 'description' => 'The queried add-ons.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'An add-on from the queried list.'."\n", - 'type' => 'object', - 'properties' => [ - 'AddonName' => [ - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'AlertRuleCount' => [ - 'description' => 'The number of alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Conditions' => [ - 'description' => 'The installation phase.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The type of the condition. Valid values:'."\n" - ."\n" - .'* **ruleName: the name of the rule**'."\n", - 'type' => 'object', - 'properties' => [ - 'FirstTransitionTime' => [ - 'description' => 'The first transition time.'."\n", - 'type' => 'string', - 'example' => '2018-01-31T14:32:19Z', - ], - 'LastTransitionTime' => [ - 'description' => 'The last transition time.'."\n", - 'type' => 'string', - 'example' => '2018-01-31T14:32:19Z', - ], - 'Message' => [ - 'description' => 'The detailed information.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Reason' => [ - 'description' => 'The reason for the failure.'."\n", - 'type' => 'string', - 'example' => 'xxxx', - ], - 'Status' => [ - 'description' => 'The status of the phase.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - 'Type' => [ - 'description' => 'The type of the phase.'."\n", - 'type' => 'string', - 'example' => 'Loaded', - ], - ], - ], - ], - 'CreateTime' => [ - 'description' => 'The time when the add-on was created.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'DashboardCount' => [ - 'description' => 'The number of dashboards.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExporterCount' => [ - 'description' => 'The number of exporters.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'HaveConfig' => [ - 'description' => 'Indicates whether the configuration is available.'."\n", - 'type' => 'boolean', - 'example' => 'true'."\n", - ], - 'InstallUserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '1268790592387', - ], - 'Language' => [ - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'ReleaseId' => [ - 'description' => 'The release ID after installation.'."\n", - 'type' => 'string', - 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', - ], - 'ReleaseName' => [ - 'description' => 'The name of the release.'."\n", - 'type' => 'string', - 'example' => 'mysql-1695372983039', - ], - 'Scene' => [ - 'description' => 'The scenario.'."\n", - 'type' => 'string', - 'example' => 'database', - ], - 'Status' => [ - 'description' => 'The status.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'UpdateTime' => [ - 'description' => 'The time when the add-on was updated.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '111', - ], - 'Version' => [ - 'description' => 'The version of the add-on.'."\n", - 'type' => 'string', - 'example' => '0.0.1', - ], - 'EnvironmentId' => [ - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'example' => 'env-xxxx', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-heyuan', - ], - 'Managed' => [ - 'description' => 'Indicates whether the component is fully managed.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'NextVersion' => [ - 'description' => 'The latest version.'."\n", - 'type' => 'string', - 'example' => '0.0.4', - ], - 'Config' => [ - 'description' => 'The configuration information of the add-on release.'."\n", - 'type' => 'string', - 'example' => '{"port":"9379"}', - ], - ], - ], - ], - 'Total' => [ - 'description' => 'The total number of entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - ], - ], + 'ArmsAgentDownloadUrl' => ['description' => 'The download URL of the ARMS agent.'."\n", 'type' => 'string', 'example' => 'http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '14043452-D486-4EA1-80C9-BA73FB81****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Releases\\": [\\n {\\n \\"AddonName\\": \\"mysql\\",\\n \\"AlertRuleCount\\": 1,\\n \\"Conditions\\": [\\n {\\n \\"FirstTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"LastTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Reason\\": \\"xxxx\\",\\n \\"Status\\": \\"True\\",\\n \\"Type\\": \\"Loaded\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"DashboardCount\\": 1,\\n \\"ExporterCount\\": 2,\\n \\"HaveConfig\\": true,\\n \\"InstallUserId\\": \\"1268790592387\\",\\n \\"Language\\": \\"zh\\",\\n \\"ReleaseId\\": \\"be29c093-3fd6-4fb6-9430-797030cc183a\\",\\n \\"ReleaseName\\": \\"mysql-1695372983039\\",\\n \\"Scene\\": \\"database\\",\\n \\"Status\\": \\"0\\",\\n \\"UpdateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"UserId\\": \\"111\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-heyuan\\",\\n \\"Managed\\": false,\\n \\"NextVersion\\": \\"0.0.4\\",\\n \\"Config\\": \\"{\\\\\\"port\\\\\\":\\\\\\"9379\\\\\\"}\\"\\n }\\n ],\\n \\"Total\\": 12\\n }\\n}","type":"json"}]', - 'title' => 'ListAddonReleases', - ], - 'DeleteAddonRelease' => [ - 'summary' => 'Delete AddonRelease data by AddonRelease name.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"ArmsAgentDownloadUrl\\": \\"http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/\\",\\n \\"RequestId\\": \\"14043452-D486-4EA1-80C9-BA73FB81****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetAgentDownloadUrlResponse>\\n<ArmsAgentDownloadUrl>http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/</ArmsAgentDownloadUrl>\\n<RequestId>14043452-D486-4EA1-80C9-BA73FB81****</RequestId>\\n</GetAgentDownloadUrlResponse>","errorExample":""}]', + 'title' => 'GetAgentDownloadUrl', + 'summary' => 'Obtains the URL for downloading an agent.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-17T02:20:44.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetAgentDownloadUrlV2' => [ + 'summary' => 'Obtains the URL for downloading an agent.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -16753,123 +11748,99 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ReleaseName', - 'in' => 'query', - 'schema' => [ - 'title' => 'addon release的名称', - 'description' => 'Name of Release.', - 'type' => 'string', - 'required' => true, - 'example' => 'agent-822567d4-2449', - ], - ], - [ - 'name' => 'Force', - 'in' => 'query', - 'schema' => [ - 'title' => '是否硬性删除,默认false', - 'description' => 'Whether to be forcibly deleted. The default value is false.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'AgentType', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The agent type.\\'."\n" + .'**Valid values:**'."\n" + ."\n" + .'* **JavaAgent**'."\n" + .'* **Instgo**'."\n", 'type' => 'string', 'required' => true, 'example' => 'JavaAgent', 'title' => ''], ], [ - 'name' => 'EnvironmentId', + 'name' => 'OsType', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'Environment ID.', - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The operating system of the environment where the agent is installed.\\'."\n" + .'This parameter is required and valid only when **AgentType** is set to **Instgo**.\\'."\n" + .'**Valid values:**'."\n" + ."\n" + .'* **linux**'."\n" + .'* **darwin**'."\n" + .'* **windows**'."\n", 'type' => 'string', 'required' => false, 'example' => 'linux', 'title' => ''], ], [ - 'name' => 'AddonName', + 'name' => 'ArchType', 'in' => 'query', - 'schema' => [ - 'title' => 'Addon名称。', - 'description' => 'The name of the add-on. If you assign a value to AddonName, the ReleaseName parameter is ignored and all AddonReleases that belong to the same add-on are deleted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['description' => 'The architecture type of the environment where the agent is installed.\\'."\n" + .'This parameter is required and valid only when **AgentType** is set to **Instgo**.\\'."\n" + .'**Valid values:**'."\n" + ."\n" + .'* **amd64**'."\n" + .'* **arm64**'."\n", 'type' => 'string', 'required' => false, 'example' => 'amd64', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - 'Code' => [ - 'description' => 'Status code: 200 indicates success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" - ."\n" - .'* `true`: The alert rule was deleted.'."\n" - .'* `false`: The alert rule failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', 'title' => ''], 'Data' => [ - 'description' => 'Return a message.', - 'type' => 'string', - 'example' => 'success', + 'description' => 'The version number and download URL of the agent.'."\n", + 'type' => 'object', + 'properties' => [ + 'Version' => ['description' => 'The version number of the agent.'."\n", 'type' => 'string', 'example' => '3.2.9', 'title' => ''], + 'Url' => ['description' => 'The download URL of the agent.'."\n", 'type' => 'string', 'example' => 'http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '探针类型错误', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.\\'."\n" + .'**Valid values:**'."\n" + ."\n" + .'* 2xx: The request was successful.'."\n" + .'* 3xx: The request was redirected.'."\n" + .'* 4xx: The request was invalid.'."\n" + .'* 5xx: A server error occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.\\'."\n" + .'**Valid values:**'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteAddonRelease', - ], - 'ListEnvironmentDashboards' => [ - 'summary' => 'Queries information about a dashboard of an environment instance.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 404 => [ + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The application does not exist.', 'description' => 'The application does not exist.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Data\\": {\\n \\"Version\\": \\"3.2.9\\",\\n \\"Url\\": \\"http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip\\"\\n },\\n \\"Message\\": \\"探针类型错误\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetAgentDownloadUrlV2', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetAlertRules' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -16878,697 +11849,848 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '109306', + 'abilityTreeNodes' => ['FEATUREarms20UGKV'], ], 'parameters' => [ [ - 'name' => 'EnvironmentId', + 'name' => 'AlertIds', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The unique IDs of alert rules.'."\n" + ."\n" + .'- If you do not specify this parameter, the API operation does not filter alert rules based on their IDs.'."\n" + ."\n" + .'- If you specify this parameter, the API operation returns only the information of the specified alert rules. Other filter conditions also take effect.'."\n" + ."\n" + .'> When you call the GetAlertRules operation, you can specify other request parameters to obtain the AlertIds parameter from the response. Then, you can specify the AlertIds parameter to query the specified alert rules.', 'type' => 'string', 'example' => '["12345"]', 'title' => '', 'required' => false], + ], + [ + 'name' => 'AlertNames', + 'in' => 'query', + 'schema' => ['description' => 'The names of alert rules. When you create alert rules of the new version, you cannot specify duplicate names. However, existing alert rules may have duplicate names. Therefore, the **AlertName** parameter does not uniquely identify an alert rule.'."\n" + ."\n" + .'- If you do not specify this parameter, the API operation does not filter alert rules based on their names.'."\n" + ."\n" + .'- If you specify this parameter, the API operation returns only the information of the specified alert rules. Other filter conditions also take effect.', 'type' => 'string', 'required' => false, 'example' => '["test"]', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'AlertType', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID of the instance.'."\n", + 'description' => 'The type of the alert rule. This parameter is required for the new version of Alert Management. Valid values:'."\n" + ."\n" + .'- APPLICATION\\_MONITORING\\_ALERT\\_RULE: alert rule for Application Monitoring'."\n" + ."\n" + .'- BROWSER\\_MONITORING\\_ALERT\\_RULE: alert rule for Browser Monitoring'."\n" + ."\n" + .'- PROMETHEUS\\_MONITORING\\_ALERT\\_RULE: alert rule for Managed Service for Prometheus', 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'example' => 'APPLICATION_MONITORING_ALERT_RULE', + 'enum' => ['BROWSER_MONITORING_ALERT_RULE', 'APPLICATION_MONITORING_ALERT_RULE', 'PROMETHEUS_MONITORING_ALERT_RULE', 'browser monitoring alert', 'application monitoring alert', 'prometheus monitoring alert'], + 'title' => '', ], ], [ - 'name' => 'AddonName', + 'name' => 'AlertStatus', 'in' => 'query', 'schema' => [ - 'title' => 'addon的名称,addonName和scene必填一个', - 'description' => 'Name of Addon,One of AddonName and Scene must be filled in.', + 'description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- STOPPED'."\n" + ."\n" + .'- PAUSED'."\n" + ."\n" + .'> The PAUSED state indicates an abnormal and paused alert rule. This may result from excessively large threshold values or deleted associated clusters.', 'type' => 'string', + 'example' => 'RUNNING', + 'enum' => ['STOPPED', 'RUNNING', 'PAUSED'], + 'title' => '', 'required' => false, - 'example' => 'trace-java', ], ], [ - 'name' => 'Scene', + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the monitored cluster.', 'type' => 'string', 'required' => false, 'example' => 'ceba9b9ea5b924dd0b6726d2de6******'."\n", 'title' => ''], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => ['description' => 'You do not need to configure this parameter.', 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['description' => 'The number of alert rules to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '场景,addonName和scene必填一个', - 'description' => 'The scenario of Addon. Either AddonName or Scene is required.'."\n", - 'type' => 'string', + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'type', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'prod', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'database', + 'maxItems' => 1, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'BizRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The area ID where the rule resides.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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' => 'message', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The result of the operation.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', 'title' => ''], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned pages.', 'type' => 'object', 'properties' => [ - 'Dashboards' => [ - 'description' => 'The dashboards.'."\n", + 'Total' => ['description' => 'The total number of queried alert rules.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Page' => ['description' => 'The number of pages returned.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'Size' => ['description' => 'The number of alert rules returned per page.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '20'], + 'AlertRules' => [ + 'title' => '', + 'description' => 'The alert rules.', 'type' => 'array', 'items' => [ - 'description' => 'Dashboard details.', + 'description' => 'The details of each alert rule.', 'type' => 'object', 'properties' => [ - 'FolderUid' => [ - 'description' => 'The UID of the folder.'."\n", - 'type' => 'string', - 'example' => '1374923841627893', + 'AlertId' => ['description' => 'The alert rule ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '5730***', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'title' => '', 'example' => 'arms-test'], + 'UserId' => ['description' => 'The ID of the Alibaba Cloud account.', 'type' => 'string', 'title' => '', 'example' => '1131971649******'], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'title' => '', 'example' => 'cn-hangzhou'], + 'AlertType' => ['description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'- APPLICATION\\_MONITORING\\_ALERT\\_RULE: alert rule for Application Monitoring'."\n" + ."\n" + .'- BROWSER\\_MONITORING\\_ALERT\\_RULE: alert rule for Browser Monitoring'."\n" + ."\n" + .'- PROMETHEUS\\_MONITORING\\_ALERT\\_RULE: Prometheus alert rule', 'type' => 'string', 'title' => '', 'example' => 'APPLICATION_MONITORING_ALERT_RULE'], + 'AlertStatus' => ['description' => 'The status of the alert rule. Valid values:'."\n" + ."\n" + .'- RUNNING'."\n" + ."\n" + .'- STOPPED'."\n" + ."\n" + .'- PAUSED'."\n" + ."\n" + .'> The PAUSED state indicates that the alert rule is abnormal and has been suspended. This may be because the specified threshold value is excessively large, or the associated cluster has been deleted.', 'type' => 'string', 'title' => '', 'example' => 'RUNNING'], + 'CreatedTime' => ['description' => 'The time when the alert rule was created. The value is a timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1640333981000'], + 'UpdatedTime' => ['description' => 'The time when the alert rule was updated. The value is a timestamp. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1640333981000'], + 'Extend' => ['description' => 'The extended fields.'."\n" + ."\n" + .'> For existing Application Monitoring alert rules, the fields contain information such as contacts, alert template, and notification content.', 'type' => 'string', 'title' => '', 'example' => '{\\"alarmContext\\":\\"{\\\\\\"content\\\\\\":\\\\\\"报警名称:$报警名称\\\\\\\\n筛选条件: $筛选\\\\\\\\n报警时间: $报警时间\\\\\\\\n报警内容: $报警内容\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\",\\\\\\"subTitle\\\\\\":\\\\\\"\\\\\\"}\\",\\"alertWays\\":\\"[0,1]\\",\\"contactGroupIds\\":\\"381,5075\\",\\"notice\\":\\"{\\\\\\"endTime\\\\\\":1480607940000,\\\\\\"noticeEndTime\\\\\\":1480607940000,\\\\\\"noticeStartTime\\\\\\":1480521600000,\\\\\\"startTime\\\\\\":1480521600000}\\"}'], + 'NotifyStrategy' => ['description' => 'The name of the notification policy.', 'type' => 'string', 'title' => '', 'example' => 'ALERT_MANAGER'], + 'Pids' => [ + 'title' => '', + 'description' => 'The process ID (PID) of the application to which the Application Monitoring or Browser Monitoring alert rule is applied.', + 'type' => 'array', + 'items' => ['description' => 'The PID of the application.', 'type' => 'string', 'example' => '["b590lhguqs@40d8deedfa9******"]', 'title' => ''], + 'example' => '', ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'AutoAddNewApplication' => ['description' => 'Indicates whether the alert rule is applied to new applications that are created in Application Monitoring or Browser Monitoring. Valid values:'."\n" + ."\n" + .'- `true`: yes'."\n" + ."\n" + .'- `false`: no', 'type' => 'boolean', 'title' => '', 'example' => 'false'], + 'MetricsType' => ['description' => 'The metric type of the Application Monitoring or Browser Monitoring alert rule.', 'type' => 'string', 'title' => '', 'example' => 'JVM'], + 'AlertRuleContent' => [ + 'title' => '', + 'description' => 'The content of the Application Monitoring or Browser Monitoring alert rule.', + 'type' => 'object', + 'properties' => [ + 'Condition' => ['description' => 'The relationship between multiple alert conditions specified for the Application Monitoring or Browser Monitoring alert rule. Valid values:'."\n" + ."\n" + .'- OR: The alert rule is triggered if one of the conditions is met.'."\n" + ."\n" + .'- AND: The alert rule is triggered if all the conditions are met.', 'type' => 'string', 'title' => '', 'example' => 'OR'], + 'AlertRuleItems' => [ + 'title' => '', + 'description' => 'The trigger conditions of the Application Monitoring or Browser Monitoring alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the alert condition.', + 'type' => 'object', + 'properties' => [ + 'N' => ['description' => 'The last N minutes.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'MetricKey' => ['description' => 'The metric of the alert condition.', 'type' => 'string', 'title' => '', 'example' => 'appstat.jvm.non_heap_used'], + 'Aggregate' => ['description' => 'The aggregation method of the alert condition. Valid values:'."\n" + ."\n" + .'- AVG: calculates the average value'."\n" + ."\n" + .'- SUM: calculates the total value'."\n" + ."\n" + .'- MAX: selects the maximum value'."\n" + ."\n" + .'- MIN: selects the minimum value', 'type' => 'string', 'title' => '', 'example' => 'AVG'], + 'Operator' => ['description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" + ."\n" + .'- CURRENT\\_GTE: greater than or equal to'."\n" + ."\n" + .'- CURRENT\\_LTE: less than or equal to'."\n" + ."\n" + .'- PREVIOUS\\_UP: increase in percentage compared with the previous period'."\n" + ."\n" + .'- PREVIOUS\\_DOWN: decrease in percentage compared with the previous period'."\n" + ."\n" + .'- HOH\\_UP: increase in percentage compared with the same period in the previous hour'."\n" + ."\n" + .'- HOH\\_DOWN: decrease in percentage compared with the same period in the previous hour'."\n" + ."\n" + .'- DOD\\_UP: increase in percentage compared with the same period in the previous day'."\n" + ."\n" + .'- DOD\\_DOWN: decrease in percentage compared with the same period in the previous day', 'type' => 'string', 'title' => '', 'example' => 'CURRENT_GTE'], + 'Value' => ['description' => 'The threshold of the alert condition.', 'type' => 'string', 'title' => '', 'example' => '1'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', ], - 'Tags' => [ - 'description' => 'The keyword.'."\n", + 'Filters' => [ + 'title' => '', + 'description' => 'The filter conditions of the Application Monitoring or Browser Monitoring alert rule.', + 'type' => 'object', + 'properties' => [ + 'DimFilters' => [ + 'description' => 'The information about each filter condition of the Application Monitoring or Browser Monitoring alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the filter condition.', + 'type' => 'object', + 'properties' => [ + 'FilterKey' => ['description' => 'The key of the filter condition.', 'type' => 'string', 'example' => 'rootIp', 'title' => ''], + 'FilterOpt' => ['description' => 'The logical operator of the filter condition.', 'type' => 'string', 'example' => 'ALL', 'title' => ''], + 'FilterValues' => [ + 'description' => 'The details of the filter condition.', + 'type' => 'array', + 'items' => ['description' => 'The parameters of the filter condition.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CustomSLSFilters' => [ + 'description' => 'The custom filter condition of the Browser Monitoring alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the custom filter condition.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the filter condition.', 'type' => 'string', 'example' => 'username', 'title' => ''], + 'Opt' => ['description' => 'The logical operator of the filter condition. Valid values:'."\n" + ."\n" + .'- \\=: equal to'."\n" + ."\n" + .'- not: not equal to', 'type' => 'string', 'example' => '=', 'title' => ''], + 'Value' => ['description' => 'The value of the filter condition.', 'type' => 'string', 'example' => 'test', 'title' => ''], + 'T' => ['description' => 'The log type of Browser Monitoring. This field is not included in other filter conditions.', 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Show' => ['description' => 'Indicates whether this filter condition is displayed on the frontend.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CustomSLSGroupByDimensions' => [ + 'description' => 'The information about the aggregation dimension.', + 'type' => 'array', + 'items' => ['description' => 'The value of the aggregation dimension.', 'type' => 'string', 'example' => '["page"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'CustomSLSWheres' => [ + 'description' => 'The details of the custom filter condition.', + 'type' => 'array', + 'items' => ['description' => 'The value of the custom filter condition.', 'type' => 'string', 'example' => '["t like \'%api%\'"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', + ], + 'AlertCheckType' => ['description' => 'The alert check type of the Prometheus alert rule.'."\n" + ."\n" + .'- STATIC: static threshold'."\n" + ."\n" + .'- CUSTOM: custom PromQL', 'type' => 'string', 'title' => '', 'example' => 'STATIC'], + 'ClusterId' => ['description' => 'The cluster ID of the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => 'ceba9b9ea5b924dd0b6726d2de6******'], + 'AlertGroup' => ['description' => 'The alert contact group ID of the Prometheus alert rule.'."\n" + ."\n" + .'- -1: custom PromQL'."\n" + ."\n" + .'- 1: Kubernetes load'."\n" + ."\n" + .'- 15: Kubernetes node', 'type' => 'integer', 'format' => 'int64', 'title' => '', 'example' => '1'], + 'PromQL' => ['description' => 'The PromQL statement of the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100'], + 'Duration' => ['description' => 'The duration of the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => '1'], + 'Level' => ['description' => 'The severity level of the Prometheus alert rule.'."\n" + ."\n" + .'- P1: Alert notifications are sent for major issues that affect the availability of core business, have a huge impact, and may lead to serious consequences.'."\n" + ."\n" + .'- P2: Alert notifications are sent for service errors that affect the system availability with relatively limited impact.'."\n" + ."\n" + .'- P3: Alert notifications are sent for issues that may cause service errors or negative effects, or alert notifications for services that are relatively less important.'."\n" + ."\n" + .'- P4: Alert notifications are sent for low-priority issues that do not affect your business.'."\n" + ."\n" + .'- Default: Alert notifications are sent regardless of alert levels.', 'type' => 'string', 'title' => '', 'example' => 'P2'], + 'Message' => ['description' => 'The alert message of the Prometheus alert rule.', 'type' => 'string', 'title' => '', 'example' => '命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf "%.2f" $value }}%'], + 'Labels' => [ + 'title' => '', + 'description' => 'The tags of the Prometheus alert rule.', 'type' => 'array', 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => 'k8s', + 'description' => 'The tag struct.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The tag key.', 'type' => 'string', 'title' => '', 'example' => '123'], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'title' => '', 'example' => 'abc'], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], - 'Title' => [ - 'description' => 'The title of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'kafka-instance', - ], - 'Uid' => [ - 'description' => 'The unique identifier of the dashboard.'."\n", - 'type' => 'string', - 'example' => '1537863211936042', + 'Annotations' => [ + 'title' => '', + 'description' => 'The annotations of the Prometheus alert rule.', + 'type' => 'array', + 'items' => [ + 'description' => 'The annotation struct.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The key of the annotation.', 'type' => 'string', 'title' => '', 'example' => '123'], + 'Value' => ['description' => 'The value of the annotation.', 'type' => 'string', 'title' => '', 'example' => 'abc'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'Url' => [ - 'description' => 'The complete URL of the dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', + 'Tags' => [ + 'description' => 'The tags of the alert rule.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'type', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'prod', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', + 'example' => '', ], ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dashboards\\": [\\n {\\n \\"FolderUid\\": \\"1374923841627893\\",\\n \\"Region\\": \\"cn-hongkong\\",\\n \\"Tags\\": [\\n \\"k8s\\"\\n ],\\n \\"Title\\": \\"kafka-instance\\",\\n \\"Uid\\": \\"1537863211936042\\",\\n \\"Url\\": \\"http://xxx\\"\\n }\\n ],\\n \\"Total\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListEnvironmentDashboards', + 'title' => 'Retrieve created alert rules', + 'summary' => 'Query the created alert rules.', + 'extraInfo' => '### More Examples'."\n" + .'### Retrieve frontend monitoring alert rules in the China (Hangzhou) region'."\n" + .'**Sample Request:**'."\n" + .'```'."\n" + .'http(s)://[Endpoint]/?Action=GetAlertRules'."\n" + .'&AlertIds=["12345"]'."\n" + .'&AlertNames=["Default Frontend Monitoring Alert"]'."\n" + .'&RegionId=cn-hangzhou'."\n" + .'&AlertType=BROWSER_MONITORING_ALERT_RULE'."\n" + .'&AlertStatus=STOPPED'."\n" + .'&Page=1'."\n" + .'&Size=20'."\n" + .'&Common Request Parameters'."\n" + .'```'."\n" + .'**Sample Response:**'."\n" + .'```'."\n" + .'{'."\n" + .' "PageBean": {'."\n" + .' "AlertRules": ['."\n" + .' {'."\n" + .' "AlertId": 12345,'."\n" + .' "AlertName": "Default Frontend Monitoring Alert",'."\n" + .' "AlertRuleContent": {'."\n" + .' "AlertRuleItems": ['."\n" + .' {'."\n" + .' "Aggregate": "AVG",'."\n" + .' "MetricKey": "webstat.jsError.rate",'."\n" + .' "N": 10,'."\n" + .' "Operator": "CURRENT_GTE",'."\n" + .' "Value": 0.2'."\n" + .' },'."\n" + .' {'."\n" + .' "Aggregate": "SUM",'."\n" + .' "MetricKey": "webstat.jsError.count",'."\n" + .' "N": 10,'."\n" + .' "Operator": "CURRENT_GTE",'."\n" + .' "Value": 20.0'."\n" + .' }'."\n" + .' ],'."\n" + .' "Condition": "AND"'."\n" + .' },'."\n" + .' "AlertStatus": "STOPPED",'."\n" + .' "AlertType": "BROWSER_MONITORING_ALERT_RULE",'."\n" + .' "AutoAddNewApplication": false,'."\n" + .' "CreatedTime": 1625824851000,'."\n" + .' "Extend": "{"alarmContext":"{\\"content\\":\\"Alert Name: $Alert Name\\\\\\\\'."\n" + .'Filter Conditions: $Filter\\\\\\\\'."\n" + .'Alert Time: $Alert Time\\\\\\\\'."\n" + .'Alert Content: $Alert Content\\\\\\\\'."\n" + .'Note! This alert will continue until a recovery email is received. You will be reminded again after 24 hours!\\",\\"subTitle\\":\\"\\"}","alertWays":"[0,1]","contactGroupIds":"299","notice":"{\\"endTime\\":1480607940000,\\"noticeEndTime\\":1480607940000,\\"noticeStartTime\\":1480521600000,\\"startTime\\":1480521600000}"}",'."\n" + .' "Filters": {'."\n" + .' "DimFilters": ['."\n" + .' {'."\n" + .' "FilterKey": "page",'."\n" + .' "FilterOpt": "ALL",'."\n" + .' "FilterValues": ['."\n" + .' null'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "MetricsType": "page",'."\n" + .' "Pids": ['."\n" + .' "aokcdqn3ly@6a6c*******"'."\n" + .' ],'."\n" + .' "RegionId": "cn-hangzhou",'."\n" + .' "UpdatedTime": 1625824851000,'."\n" + .' "UserId": "1084*********"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Size": 20,'."\n" + .' "Total": 1,'."\n" + .' "Page": 1'."\n" + .' },'."\n" + .' "RequestId": "A87CE2E7-8115-5A9C-8F4B-7C9DD7******"'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + .'### Retrieve Prometheus monitoring alert rules in the China (Hangzhou) region'."\n" + .'**Sample Request:**'."\n" + .'```'."\n" + .'http(s)://[Endpoint]/?Action=GetAlertRules'."\n" + .'&AlertIds=["12345"]'."\n" + .'&AlertNames=["ES Edge Zone Disk Usage Exceeds 85%"]'."\n" + .'&RegionId=cn-hangzhou'."\n" + .'&AlertType=PROMETHEUS_MONITORING_ALERT_RULE'."\n" + .'&AlertStatus=RUNNING'."\n" + .'&Page=1'."\n" + .'&Size=20'."\n" + .'&Common Request Parameters'."\n" + .'```'."\n" + .'**Sample Response:**'."\n" + .'```'."\n" + .'{'."\n" + .' "PageBean": {'."\n" + .' "AlertRules": ['."\n" + .' {'."\n" + .' "AlertName": "ES Edge Zone Disk Usage Exceeds 85%",'."\n" + .' "CreatedTime": 1643188668035,'."\n" + .' "Message": "Cluster ID: {{$labels.cluster_id}} Edge Zone IP: {{$labels.node_id}} Disk Usage Alert Value at Trigger Time: {{ printf "%.2f" $value }}%'."\n" + .'Details: https://elasticsearch.console.aliyun.com/{{$labels.region}}/instances/{{$labels.cluster_id}}/base",'."\n" + .' "ClusterId": "n9p9****",'."\n" + .' "PromQL": "arms_cms_es_node_disk_utilization > 85",'."\n" + .' "AlertCheckType": "CUSTOM",'."\n" + .' "AlertRuleContent": {},'."\n" + .' "NotifyStrategy": "ALERT_MANAGER",'."\n" + .' "Duration": 10,'."\n" + .' "Labels": ['."\n" + .' {'."\n" + .' "Value": "cms_es",'."\n" + .' "Name": "_aliyun_cloud_product"'."\n" + .' }'."\n" + .' ],'."\n" + .' "AlertType": "PROMETHEUS_MONITORING_ALERT_RULE",'."\n" + .' "AlertId": 12345,'."\n" + .' "AlertGroup": -1,'."\n" + .' "Filters": {},'."\n" + .' "Annotations": ['."\n" + .' {'."\n" + .' "Value": "ES Edge Zone Disk Usage",'."\n" + .' "Name": "_aliyun_display_name"'."\n" + .' },'."\n" + .' {'."\n" + .' "Value": "Cluster ID: {{$labels.cluster_id}} Edge Zone IP: {{$labels.node_id}} Disk Usage Alert Value at Trigger Time: {{ printf "%.2f" $value }}%'."\n" + .'Details: https://elasticsearch.console.aliyun.com/{{$labels.region}}/instances/{{$labels.cluster_id}}/base",'."\n" + .' "Name": "message"'."\n" + .' },'."\n" + .' {'."\n" + .' "Value": "arms_cms_es_node_disk_utilization",'."\n" + .' "Name": "_aliyun_display_promql"'."\n" + .' }'."\n" + .' ],'."\n" + .' "Extend": "",'."\n" + .' "UserId": "10983*********",'."\n" + .' "AlertStatus": "RUNNING",'."\n" + .' "Level": "P6",'."\n" + .' "RegionId": "cn-hangzhou",'."\n" + .' "UpdatedTime": 1643188668035'."\n" + .' }'."\n" + .' ],'."\n" + .' "Size": 20,'."\n" + .' "Total": 1,'."\n" + .' "Page": 1'."\n" + .' },'."\n" + .' "RequestId": "A87CE2E7-8115-5A9C-8F4B-7C9DD7******"'."\n" + .'}'."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2025-12-01T02:26:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-07-25T02:28:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-29T11:56:29.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-21T07:35:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-11T12:16:03.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-28T10:12:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-05T10:25:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-05T08:29:15.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-07T12:49:51.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-12-28T06:07:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-12-17T09:19:34.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2021-12-08T08:02:49.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-06T05:40:59.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlertRules'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"337B8F7E-0A64-5768-9225-E9B3CF******\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertRules\\": [\\n {\\n \\"AlertId\\": 0,\\n \\"AlertName\\": \\"arms-test\\",\\n \\"UserId\\": \\"1131971649******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AlertType\\": \\"APPLICATION_MONITORING_ALERT_RULE\\",\\n \\"AlertStatus\\": \\"RUNNING\\",\\n \\"CreatedTime\\": 1640333981000,\\n \\"UpdatedTime\\": 1640333981000,\\n \\"Extend\\": \\"{\\\\\\\\\\\\\\"alarmContext\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"报警名称:$报警名称\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n筛选条件: $筛选\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警时间: $报警时间\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警内容: $报警内容\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"subTitle\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alertWays\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[0,1]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"contactGroupIds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"381,5075\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"notice\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeEndTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeStartTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000}\\\\\\\\\\\\\\"}\\",\\n \\"NotifyStrategy\\": \\"ALERT_MANAGER\\",\\n \\"Pids\\": [\\n \\"[\\\\\\"b590lhguqs@40d8deedfa9******\\\\\\"]\\"\\n ],\\n \\"AutoAddNewApplication\\": false,\\n \\"MetricsType\\": \\"JVM\\",\\n \\"AlertRuleContent\\": {\\n \\"Condition\\": \\"OR\\",\\n \\"AlertRuleItems\\": [\\n {\\n \\"N\\": 1,\\n \\"MetricKey\\": \\"appstat.jvm.non_heap_used\\",\\n \\"Aggregate\\": \\"AVG\\",\\n \\"Operator\\": \\"CURRENT_GTE\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"Filters\\": {\\n \\"DimFilters\\": [\\n {\\n \\"FilterKey\\": \\"rootIp\\",\\n \\"FilterOpt\\": \\"ALL\\",\\n \\"FilterValues\\": [\\n \\"null\\"\\n ]\\n }\\n ],\\n \\"CustomSLSFilters\\": [\\n {\\n \\"Key\\": \\"username\\",\\n \\"Opt\\": \\"=\\",\\n \\"Value\\": \\"test\\",\\n \\"T\\": \\"null\\",\\n \\"Show\\": false\\n }\\n ],\\n \\"CustomSLSGroupByDimensions\\": [\\n \\"[\\\\\\"page\\\\\\"]\\"\\n ],\\n \\"CustomSLSWheres\\": [\\n \\"[\\\\\\"t like \'%api%\'\\\\\\"]\\"\\n ]\\n },\\n \\"AlertCheckType\\": \\"STATIC\\",\\n \\"ClusterId\\": \\"ceba9b9ea5b924dd0b6726d2de6******\\",\\n \\"AlertGroup\\": 1,\\n \\"PromQL\\": \\"node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100\\",\\n \\"Duration\\": \\"1\\",\\n \\"Level\\": \\"P2\\",\\n \\"Message\\": \\"命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf \\\\\\"%.2f\\\\\\" $value }}%\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"type\\",\\n \\"Value\\": \\"prod\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'EnableMetric' => [ - 'summary' => 'Enables a discarded metric.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAppApiByPage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ccfa5e34a5c1f4ce6b916a40a12151d88', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775806', 'minimum' => '0', 'example' => '1600063200000', 'title' => ''], ], [ - 'name' => 'DropMetric', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The metric name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'kube_pod_container_status_ready', - ], + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => true, 'maximum' => '9223372036854775806', 'minimum' => '0', 'example' => '1600066800000', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '0231DA4B-3D11-5433-9376-3B5B46C7228D', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], - ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0231DA4B-3D11-5433-9376-3B5B46C7228D\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'EnableMetric', - ], - 'UpdateMetricDrop' => [ - 'summary' => 'Updates the list of discarded metrics.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The number of entries to return on each page. This parameter is no longer supported. The number of entries to return on each page. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'IntervalMills', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c3ca36c8e2693403d85c0d9f8bb1d7b6c', - ], + 'schema' => ['description' => 'The time interval between the data shards to be queried. Unit: milliseconds. Minimum value: 60000. Maximum value: 2147483647.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '60000', 'default' => '0', 'title' => ''], ], [ - 'name' => 'MetricDrop', + 'name' => 'PId', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of discarded metrics. Specify one metric name in each line.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'apiserver_request_duration_seconds_bucket'."\n" - .'etcd_request_duration_seconds_bucket'."\n" - .'apiserver_request_total'."\n" - .'container_tasks_state', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application. For information about how to obtain a PID, see [Obtain the PID of an application](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a2n80plglh@745eddxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'CCCA4B88-BD7B-5A38-89AF-C09293BD4187', - ], + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* 2XX: The request was successful.'."\n" + .'* 3XX: A redirection message was returned.'."\n" + .'* 4XX: The request was invalid.'."\n" + .'* 5XX: A server error occurred.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', 'title' => ''], + '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', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The response status. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'Total' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'string', 'example' => '2', 'title' => ''], + 'Page' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Completed' => ['description' => 'Is completed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Items' => [ + 'description' => 'The data entries.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The data entries returned.'."\n", 'type' => 'object', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::UpdateEnvDropMetricsRule', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => 'The specified region is invalid.', 'description' => 'The specified region is invalid.'], + ], + 403 => [ + ['errorCode' => 'RetcodeDailyCustomLimit', 'errorMessage' => 'Usage today has exceeded the custom limit. The current operation is prohibited.', 'description' => 'Usage today has exceeded the custom limit. The current operation is prohibited.'], + ['errorCode' => 'RetcodeDailyFreeLimit', 'errorMessage' => 'Usage today has exceeded the Essential Edition limit. The current operation is prohibited.', 'description' => 'Usage today has exceeded the Essential Edition limit. The current operation is prohibited.'], + ], + [ + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The application does not exist.', 'description' => 'The application does not exist.'], + ['errorCode' => 'RunningTaskNotExist', 'errorMessage' => 'Application data collection task does not exist or has been stopped.', 'description' => 'Application data collection task does not exist or has been stopped'], + ], + 429 => [ + ['errorCode' => 'OperationIsThrottled', 'errorMessage' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.', 'description' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.'], + ], + 452 => [ + ['errorCode' => 'OperationTimeOut', 'errorMessage' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.', 'description' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], ], - 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCCA4B88-BD7B-5A38-89AF-C09293BD4187\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'UpdateMetricDrop', - ], - 'UpdatePrometheusMonitoringStatus' => [ - 'summary' => 'Updates the status of the monitoring configuration of a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"RequestId\\": \\"B6A00968-82A8-4F14-9D1B-B53827DB****\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 10,\\n \\"Total\\": \\"2\\",\\n \\"Page\\": 1,\\n \\"Completed\\": false,\\n \\"Items\\": [\\n []\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAppApiByPageResponse>\\n<Message>message</Message>\\n<RequestId>B6A00968-82A8-4F14-9D1B-B53827DB****</RequestId>\\n<Data>\\n <PageSize>10</PageSize>\\n <Total>0</Total>\\n <Page>1</Page>\\n <Items>[]</Items>\\n</Data>\\n<Code>200</Code>\\n<Success>true</Success>\\n</GetAppApiByPageResponse>","errorExample":""}]', + 'title' => 'GetAppApiByPage', + 'summary' => 'Queries the API operations of application monitoring by page.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T09:12:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-05-28T07:55:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-01-25T10:53:42.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-06-09T02:45:21.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppApiByPage'], + ], ], + 'ramActions' => [], + ], + 'GetAppJVMConfig' => [ + 'summary' => 'Obtain the JVM configuration information of each instance of the application', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MonitoringName', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the monitoring configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob1', - ], + 'schema' => ['description' => 'The IDof the application.'."\n" + ."\n" + .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Application Monitoring** > **Applications**. On the **Applications** page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with an at sign (@) to obtain eb4zdose6v\\@9781be0f44d\\*\\*\\*\\*.', 'type' => 'string', 'required' => false, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob'."\n" - .'ecs类型的实例支持：customJob'."\n" - .'不支持probe的状态修改。', - 'description' => 'The type of the monitoring configuration. '."\n" - .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, and customJob. '."\n" - .'Valid value for a Prometheus instance for ECS: customJob. '."\n" - .'The status of probe cannot be modified.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob', - ], + 'schema' => ['description' => 'The start of the time range to query. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1480521600000', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'title' => 'run, stop。'."\n" - .'probe不支持状态设置。', - 'description' => 'The status of the monitoring configuration. Valid values: run and stop. The status of Probe cannot be modified.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'run', - ], + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1480607940000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果信息', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Code' => ['description' => 'The response code. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'JvmInfoList' => [ + 'description' => 'The list of JVM information.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Pid' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'dsv9zcel92@1455182510c5369', 'title' => ''], + 'VmArgs' => ['description' => 'The VM parameters.', 'type' => 'string', 'example' => '[-javaagent:/home/admin/.opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar, -Doneagent.plugin.arms-agent.enabled=true, -Darms.licenseKey=[******], -Darms.agent.env=K8s, -Darms.agent.podinfo.path=/etc/podinfo, -Darms.appName=productservice, -Doneagent.region=cn-hangzhou, -Dproject.name=Product]', 'title' => ''], + 'HostName' => ['description' => 'The hostname.', 'type' => 'string', 'example' => 'host_name', 'title' => ''], + 'Ip' => ['description' => 'The IP address.', 'type' => 'string', 'example' => '47.91.59.244', 'title' => ''], + 'AgentVersion' => ['description' => 'The version of the agent.', 'type' => 'string', 'example' => '1.7.0-SNAPSHOT_3.0.3_3756244', 'title' => ''], + 'ProcId' => ['description' => 'The process ID.', 'type' => 'string', 'example' => '1', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetAppJVMConfig', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'UpdatePrometheusMonitoringStatus', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"JvmInfoList\\": [\\n {\\n \\"Pid\\": \\"dsv9zcel92@1455182510c5369\\",\\n \\"VmArgs\\": \\"[-javaagent:/home/admin/.opt/ArmsAgent/arms-bootstrap-1.7.0-SNAPSHOT.jar, -Doneagent.plugin.arms-agent.enabled=true, -Darms.licenseKey=[******], -Darms.agent.env=K8s, -Darms.agent.podinfo.path=/etc/podinfo, -Darms.appName=productservice, -Doneagent.region=cn-hangzhou, -Dproject.name=Product]\\",\\n \\"HostName\\": \\"host_name\\",\\n \\"Ip\\": \\"47.91.59.244\\",\\n \\"AgentVersion\\": \\"1.7.0-SNAPSHOT_3.0.3_3756244\\",\\n \\"ProcId\\": \\"1\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'UpdatePrometheusMonitoring' => [ - 'summary' => 'Updates the monitoring configuration of a Prometheus instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetAuthToken' => [ + 'summary' => 'Obtains an authentication token. When you connect a Container Service for Kubernetes (ACK) cluster to Prometheus Service over the Internet, you must use a token for authentication.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], - ], - [ - 'name' => 'MonitoringName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the monitoring configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'podMonitor1', - ], + 'schema' => ['description' => 'The ID of the ACK cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" - .'ecs类型的实例支持：customJob、probe', - 'description' => 'The type of the monitoring configuration. '."\n" - .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" - .'Valid values for a Prometheus instance for ECS: customJob and probe.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'podMonitor', - ], - ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The monitoring configuration. The value is a YAML string.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: ServiceMonitor'."\n" - .'metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .'spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n", - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'Data' => ['description' => 'The returned authentication token.'."\n", 'type' => 'string', 'example' => 'eyJhbGciOiJIUzI1NiJ9******', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Additional Information.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Whether the query was successful:'."\n" + .'- true: Success'."\n" + .'- false: Failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'UpdatePrometheusMonitoring', - 'requestParamsDescription' => 'ServiceMonitor example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: ServiceMonitor'."\n" - .' metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .' spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n" - ."\n" - .'PodMonitor example:'."\n" - ."\n" - .' apiVersion: "monitoring.coreos.com/v1"'."\n" - .' kind: "PodMonitor"'."\n" - .' metadata:'."\n" - .' name: "podmonitor-demo"'."\n" - .' namespace: "default"'."\n" - .' spec:'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: "30s"'."\n" - .' path: "/metrics"'."\n" - .' port: "tomcat-monitor"'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: "nginx2-exporter"'."\n" - ."\n" - .'CustomJob example:'."\n" - ."\n" - .' scrape_configs:'."\n" - .' - job_name: prometheus1'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - ."\n" - .'Probe example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: Probe'."\n" - .' metadata:'."\n" - .' name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox'."\n" - .' namespace: arms-prom # Optional.'."\n" - .' spec:'."\n" - .' interval: 30s'."\n" - .' jobName: blackbox'."\n" - .' module: tcp_connect'."\n" - .' prober:'."\n" - .' path: /blackbox/probe'."\n" - .' scheme: http'."\n" - .' url: \'localhost:9335\''."\n" - .' targets:'."\n" - .' staticConfig:'."\n" - .' static:'."\n" - .' - \'arms-prom-admin.arms-prom:9335\''."\n", - ], - 'ListPrometheusMonitoring' => [ - 'summary' => 'Queries the monitoring configuration of a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"eyJhbGciOiJIUzI1NiJ9******\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAuthTokenResponse>\\n <Data>success</Data>\\n <RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n</GetAuthTokenResponse>","errorExample":""}]', + 'title' => 'GetAuthToken', + 'changeSet' => [ + ['createdAt' => '2023-03-23T09:22:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-02-25T06:33:52.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAuthToken'], + ], ], + 'ramActions' => [], + ], + 'GetCloudClusterAllUrl' => [ + 'summary' => 'Queries the read and write URLs of a CloudMonitor instance, such as Pushgateway and Grafana URLs.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -17576,46 +12698,17 @@ ], 'operationType' => 'read', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], - ], - [ - 'name' => 'Type', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" - .'ecs类型的实例支持：customJob、probe', - 'description' => 'The type of the monitoring configuration. Valid values for a Prometheus instance for Container Service: ServiceMonitor, PodMonitor, CustomJob, and Probe. Valid values for a Prometheus instance for ECS: CustomJob and Probe.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'serviceMonitor', - ], + 'schema' => ['description' => 'The ID of the CloudMonitor instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ca9676014babd4', 'title' => ''], ], ], 'responses' => [ @@ -17625,641 +12718,336 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB'], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'An array object.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about the array object.'."\n", + 'description' => 'The queried global aggregation instances. The value is a JSON string.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', - ], - 'MonitoringName' => [ - 'description' => 'The name of the monitoring configuration.'."\n", - 'type' => 'string', - 'example' => 'podMonitor1', - ], - 'Type' => [ - 'description' => 'The type of the monitoring configuration.'."\n", - 'type' => 'string', - 'example' => 'podMonitor', - ], - 'ConfigYaml' => [ - 'description' => 'The monitoring configuration. The value is a YAML string.'."\n", - 'type' => 'string', - 'example' => 'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: ServiceMonitor'."\n" - .'metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .'spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n", - ], - 'Status' => [ - 'description' => 'The status of the monitoring configuration.'."\n", - 'type' => 'string', - 'example' => 'run', + 'ProductCode' => ['description' => 'The identifier of the cloud service.'."\n", 'type' => 'string', 'example' => 'amp', 'title' => ''], + 'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'RemoteUrl' => [ + 'description' => 'The URLs for remote read and write. The value is a JSON string.'."\n", + 'type' => 'object', + 'properties' => [ + 'RemoteWriteUrl' => ['description' => 'The internal URL for remote write.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'InternetRemoteWriteUrl' => ['description' => 'The public URL for remote write.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'RemoteReadUrl' => ['description' => 'The internal URL for remote read.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'InternetRemoteReadUrl' => ['description' => 'The public URL for remote read.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"', 'title' => ''], + 'GrafanaUrl' => ['description' => 'The internal URL for Grafana.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'InternetGrafanaUrl' => ['description' => 'The public URL for Grafana.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'InternetPushGatewayUrl' => ['description' => 'The public URL for Pushgateway.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'PushGatewayUrl' => ['description' => 'The internal URL for Pushgateway.'."\n", 'type' => 'string', 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", 'title' => ''], + 'AuthToken' => ['description' => 'Indicates whether authentication is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Token' => ['description' => 'The token value used for authentication.'."\n", 'type' => 'string', 'example' => '"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw"', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'substitutions' => ['ARMS::2019-08-08::GetRemoteWriteUrl'], 'returnType' => 'synchronous', ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D80ADAAC-8C32-5479-BD14-C28CF832****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"ClusterId\\": \\"c589a1b8db05c4561aefbb898ca8fb1cf\\",\\n \\"MonitoringName\\": \\"podMonitor1\\",\\n \\"Type\\": \\"podMonitor\\",\\n \\"ConfigYaml\\": \\"参见返回参数补充说明。\\",\\n \\"Status\\": \\"run\\"\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ListPrometheusMonitoring', - 'responseParamsDescription' => 'ServiceMonitor example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: ServiceMonitor'."\n" - .' metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .' spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n" - ."\n" - .'PodMonitor example:'."\n" - ."\n" - .' apiVersion: "monitoring.coreos.com/v1"'."\n" - .' kind: "PodMonitor"'."\n" - .' metadata:'."\n" - .' name: "podmonitor-demo"'."\n" - .' namespace: "default"'."\n" - .' spec:'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: "30s"'."\n" - .' path: "/metrics"'."\n" - .' port: "tomcat-monitor"'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: "nginx2-exporter"'."\n" - ."\n" - .'CustomJob example:'."\n" - ."\n" - .' scrape_configs:'."\n" - .' - job_name: prometheus1'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - ."\n" - .'Probe example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: Probe'."\n" - .' metadata:'."\n" - .' name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox'."\n" - .' namespace: arms-prom'."\n" - .' spec:'."\n" - .' interval: 30s'."\n" - .' jobName: blackbox'."\n" - .' module: tcp_connect'."\n" - .' prober:'."\n" - .' path: /blackbox/probe'."\n" - .' scheme: http'."\n" - .' url: \'localhost:9335\''."\n" - .' targets:'."\n" - .' staticConfig:'."\n" - .' static:'."\n" - .' - \'arms-prom-admin.arms-prom:9335\''."\n", - ], - 'GetPrometheusMonitoring' => [ - 'summary' => 'Queries the monitoring configuration of a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'title' => 'GetCloudClusterAllUrl', + 'changeSet' => [ + ['createdAt' => '2023-03-23T09:22:44.000Z', 'description' => 'Response parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCloudClusterAllUrl'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99A663CB-8D7B-4B0D-A006-03C8EE38E7BB\\",\\n \\"Data\\": [\\n {\\n \\"ProductCode\\": \\"amp\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"RemoteUrl\\": {\\n \\"RemoteWriteUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetRemoteWriteUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"RemoteReadUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetRemoteReadUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\",\\n \\"GrafanaUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetGrafanaUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetPushGatewayUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"PushGatewayUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"AuthToken\\": true,\\n \\"Token\\": \\"\\\\\\"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw\\\\\\"\\"\\n }\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetClusterAllUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The response parameters in the JSON format.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "RequestId": "41877338-646B-5DD6-BFBE-F89F1E7245AD",'."\n" + .' "Data": "{\\"clusterType\\":\\"ManagedKubernetes\\",\\"remoteWriteUrl\\":\\"http:/" }', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The prompt information of the returned result.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Whether the query is successful:'."\n" + .'- true: success'."\n" + .'- false: failure', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => [ + 'substitutions' => ['ARMS::2019-08-08::GetPrometheusInstance'], + ], + 'title' => 'GetClusterAllUrl', + 'summary' => 'Obtains all the URLs of a cluster, including remote read and write URLs, Pushgateway URLs, and Grafana URLs.', + 'changeSet' => [ + ['createdAt' => '2023-03-23T09:22:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-27T06:26:20.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClusterAllUrl'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"41877338-646B-5DD6-BFBE-F89F1E7245AD\\\\\\",\\\\n \\\\\\"Data\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"clusterType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ManagedKubernetes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remoteWriteUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http:/\\\\\\" }\\",\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'GetCommercialStatus' => [ + 'summary' => 'Queries whether the current account has activated the commercial edition of a service.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'Type', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" - .'ecs类型的实例支持：customJob、probe', - 'description' => 'The type of the monitoring configuration. '."\n" - .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" - .'Valid values for a Prometheus instance for ECS: customJob and probe.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MonitoringName', + 'name' => 'CommodityCode', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The name of the monitoring configuration.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob1', - ], + 'schema' => ['description' => 'The product code.'."\n" + ."\n" + .'* arms_app_post'."\n" + .'* arms_web_post'."\n" + .'* arms_promethues_public_cn'."\n" + .'* prometheus_pay_public_cn'."\n" + .'* xtrace'."\n" + .'* arms_serverless_public_cn'."\n" + .'* arms_rumserverless_public_cn'."\n" + .'* prometheus_serverless_public_cn'."\n" + .'* xtrace_serverless_public_cn'."\n", 'type' => 'string', 'required' => true, 'example' => 'arms_app_post', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '49C82193-E991-5F6A-AF3E-1664D8******'], + 'UserAndCommodityStatus' => [ + 'description' => 'The commercialization status of the service.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', - ], - 'MonitoringName' => [ - 'description' => 'The name of the monitoring configuration.'."\n", - 'type' => 'string', - 'example' => 'customJob1', - ], - 'Type' => [ - 'title' => 'serviceMonitor、podMonitor、customJob、probe', - 'description' => 'The type of the monitoring configuration. Valid values: serviceMonitor, podMonitor, customJob, and probe.', - 'type' => 'string', - 'example' => 'serviceMonitor', - ], 'Status' => [ - 'title' => 'run, stop', - 'description' => 'The status of the monitoring configuration. Valid values: run and stop.'."\n", - 'type' => 'string', - 'example' => 'run', - ], - 'ConfigYaml' => [ - 'description' => 'The monitoring configuration. The value is a YAML string.'."\n", + 'description' => 'The commercialization status.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* Normal: The service is activated.'."\n" + .'* Abnormal: An exception occurs during activation.'."\n" + .'* Free: The service is not activated.'."\n", 'type' => 'string', - 'example' => 'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: ServiceMonitor'."\n" - .'metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .'spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat', + 'enumValueTitles' => ['Normal' => 'Normal', 'Abnormal' => 'Abnormal', 'Free' => ''], + 'example' => 'Normal', + 'title' => '', ], + 'FreeDays' => ['description' => 'The number of days during which the service is free of charge.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Basic' => ['description' => 'Indicates whether you are using the Basic Edition.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ChargeType' => ['description' => 'The billing method.'."\n", 'type' => 'string', 'example' => 'usage', 'title' => ''], + 'Lable' => ['description' => 'The tags.'."\n", 'type' => 'string', 'example' => 'NEW', 'title' => ''], + 'ExtraInfo' => ['description' => 'The additional information.'."\n", 'type' => 'object', 'example' => 'info', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the service is activated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"ClusterId\\": \\"c589a1b8db05c4561aefbb898ca8fb1cf\\",\\n \\"MonitoringName\\": \\"customJob1\\",\\n \\"Type\\": \\"serviceMonitor\\",\\n \\"Status\\": \\"run\\",\\n \\"ConfigYaml\\": \\"参见返回参数补充说明。\\"\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'GetPrometheusMonitoring', - 'responseParamsDescription' => 'ServiceMonitor example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: ServiceMonitor'."\n" - .' metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .' spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n" - ."\n" - .'PodMonitor example:'."\n" - ."\n" - .' apiVersion: "monitoring.coreos.com/v1"'."\n" - .' kind: "PodMonitor"'."\n" - .' metadata:'."\n" - .' name: "podmonitor-demo"'."\n" - .' namespace: "default"'."\n" - .' spec:'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: "30s"'."\n" - .' path: "/metrics"'."\n" - .' port: "tomcat-monitor"'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: "nginx2-exporter"'."\n" - ."\n" - .'CustomJob example:'."\n" - ."\n" - .' scrape_configs:'."\n" - .' - job_name: prometheus1'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - ."\n" - .'Probe example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: Probe'."\n" - .' metadata:'."\n" - .' name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox'."\n" - .' namespace: arms-prom # Optional.'."\n" - .' spec:'."\n" - .' interval: 30s'."\n" - .' jobName: blackbox'."\n" - .' module: tcp_connect'."\n" - .' prober:'."\n" - .' path: /blackbox/probe'."\n" - .' scheme: http'."\n" - .' url: \'localhost:9335\''."\n" - .' targets:'."\n" - .' staticConfig:'."\n" - .' static:'."\n" - .' - \'arms-prom-admin.arms-prom:9335\''."\n", - ], - 'DeletePrometheusMonitoring' => [ - 'summary' => 'Deletes the monitoring configuration of a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49C82193-E991-5F6A-AF3E-1664D8******\\",\\n \\"UserAndCommodityStatus\\": {\\n \\"Status\\": \\"Normal\\",\\n \\"FreeDays\\": 10,\\n \\"Basic\\": false,\\n \\"ChargeType\\": \\"usage\\",\\n \\"Lable\\": \\"NEW\\",\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Enable\\": true\\n }\\n}","type":"json"}]', + 'title' => 'GetCommercialStatus', + 'changeSet' => [ + ['createdAt' => '2024-06-20T02:56:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-17T06:24:55.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommercialStatus'], + ], ], + ], + 'GetExploreUrl' => [ + 'summary' => 'Retrieves data using the Explore feature of Grafana.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c9cc4c5e220f8461f9d71b6ec6e******', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', 'schema' => [ - 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" - .'ecs类型的实例支持：customJob、probe', - 'description' => 'The type of the monitoring configuration. '."\n" - .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" - .'Valid values for a Prometheus instance for ECS: customJob and probe.', + 'description' => 'The Grafana data source type.', + 'enumValueTitles' => ['loki' => 'loki', 'prometheus' => 'prometheus'], 'type' => 'string', 'required' => true, 'docRequired' => true, - 'example' => 'probe', + 'example' => 'prometheus', + 'title' => '', ], ], [ - 'name' => 'MonitoringName', + 'name' => 'Expression', 'in' => 'query', 'schema' => [ - 'description' => 'The name of the monitoring configuration.'."\n", + 'description' => 'The query statement for the data source.', + 'enumValueTitles' => ['{level="WARN"}' => '{level="WARN"}', '{level="ERROR"}' => '{level="ERROR"}'], 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'customJob1', + 'required' => false, + 'example' => '{app="buy2"}', + 'title' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '操作结果描述', - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'example' => '-', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. A value of 200 indicates success. Other values indicate errors.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values:'."\n" + .'- true: The operation was successful.'."\n" + .'- false: The operation failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'title' => 'Retrieve grafana explore data', + 'changeSet' => [ + ['createdAt' => '2023-03-23T09:22:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-13T03:38:32.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-09-13T03:38:32.000Z', 'description' => 'Error codes changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'DeletePrometheusMonitoring', - ], - 'CreatePrometheusMonitoring' => [ - 'summary' => 'Creates a monitoring configuration for a Prometheus instance.', - 'methods' => [ - 'post', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExploreUrl'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetExploreUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"-\\",\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'GetGrafanaWorkspace' => [ + 'summary' => 'Queries the information about a Grafana workspace.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例ID', - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'GrafanaWorkspaceId', 'in' => 'query', - 'schema' => [ - 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" - .'ecs类型的实例支持：customJob、probe', - 'description' => 'The type of the monitoring configuration. '."\n" - .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" - .'Valid values for a Prometheus instance for ECS: customJob and probe.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'serviceMonitor', - ], + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'grafana-cn-4xl3g******', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'run, stop。'."\n" - .'为空时，默认是run。'."\n" - .'probe不支持状态设置，该参数不填。', - 'description' => 'The status of the monitoring configuration. Valid values: run and stop. Default value: run. This parameter is not available if the Type parameter is set to Probe.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'run', - ], - ], - [ - 'name' => 'ConfigYaml', - 'in' => 'formData', - 'schema' => [ - 'title' => 'serviceMonitor、podMonitor、customJob、probe对应的 yaml串。'."\n" - .'probe时，容器服务类型实例的metadata.namespace为"arms-prom"，ecs类型实例的metadata.namespace为{userId}-{vpcId}，托管ask实例的metadata.namespace为ask-{clusterId}。'."\n" - ."\n" - .'serviceMonitor示例：'."\n" - .'`'."\n" - .'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: ServiceMonitor'."\n" - .'metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .'spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n" - .'`'."\n" - ."\n" - .'podMonitor示例：'."\n" - .'`'."\n" - .'apiVersion: "monitoring.coreos.com/v1"'."\n" - .'kind: "PodMonitor"'."\n" - .'metadata:'."\n" - .' name: "podmonitor-demo"'."\n" - .' namespace: "default"'."\n" - .'spec:'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: "30s"'."\n" - .' path: "/metrics"'."\n" - .' port: "tomcat-monitor"'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: "nginx2-exporter"'."\n" - .'`'."\n" - ."\n" - .'customJob示例：'."\n" - .'`'."\n" - .'scrape_configs:'."\n" - .'- job_name: prometheus1'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - .'`'."\n" - ."\n" - .'probe示例：'."\n" - .'`'."\n" - .'apiVersion: monitoring.coreos.com/v1'."\n" - .'kind: Probe'."\n" - .'metadata:'."\n" - .' name: name1-tcp-blackbox #规则：xxx-{tcp/http/ping}-blackbox'."\n" - .' namespace: arms-prom #可选，服务端自动填写'."\n" - .'spec:'."\n" - .' interval: 30s'."\n" - .' jobName: blackbox'."\n" - .' module: tcp_connect'."\n" - .' prober:'."\n" - .' path: /blackbox/probe'."\n" - .' scheme: http'."\n" - .' url: \'localhost:9335\''."\n" - .' targets:'."\n" - .' staticConfig:'."\n" - .' static:'."\n" - .' - \'arms-prom-admin.arms-prom:9335\''."\n" - .'`', - 'description' => 'The monitoring configuration. Specify a YAML string.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Please refer to the supplementary explanation of the request parameters.', - ], + 'schema' => ['description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ @@ -18269,117 +13057,57 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'title' => '返回成功增加的remoewrite名称，或异常信息。', - 'description' => 'The name of the monitoring configuration that was added, or the exception information.'."\n", - 'type' => 'string', - 'example' => 'name1', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2C3F217B-9AAE-5D51-974D-48********'], + 'Data' => ['description' => 'The information about the Grafana workspace.'."\n", '$ref' => '#/components/schemas/GrafanaWorkspace', 'title' => '', 'example' => ''], + 'Message' => ['description' => 'The error message returned when the request parameters are invalid.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* `2XX`: The request is successful.'."\n" + .'* `3XX`: A redirection message is returned.'."\n" + .'* `4XX`: The request is invalid.'."\n" + .'* `5XX`: A server error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TraceId' => ['description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", 'type' => 'string', 'example' => 'eac0a8048716731735000007137d000b', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"name1\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'CreatePrometheusMonitoring', - 'requestParamsDescription' => 'ServiceMonitor example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: ServiceMonitor'."\n" - .' metadata:'."\n" - .' name: tomcat-demo'."\n" - .' namespace: default'."\n" - .' spec:'."\n" - .' endpoints:'."\n" - .' - interval: 30s'."\n" - .' path: /metrics'."\n" - .' port: tomcat-monitor'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: tomcat'."\n" - ."\n" - .'PodMonitor example:'."\n" - ."\n" - .' apiVersion: "monitoring.coreos.com/v1"'."\n" - .' kind: "PodMonitor"'."\n" - .' metadata:'."\n" - .' name: "podmonitor-demo"'."\n" - .' namespace: "default"'."\n" - .' spec:'."\n" - .' namespaceSelector:'."\n" - .' any: true'."\n" - .' podMetricsEndpoints:'."\n" - .' - interval: "30s"'."\n" - .' path: "/metrics"'."\n" - .' port: "tomcat-monitor"'."\n" - .' selector:'."\n" - .' matchLabels:'."\n" - .' app: "nginx2-exporter"'."\n" - ."\n" - .'CustomJob example:'."\n" - ."\n" - .' scrape_configs:'."\n" - .' - job_name: prometheus1'."\n" - .' honor_timestamps: false'."\n" - .' honor_labels: false'."\n" - .' scheme: http'."\n" - .' metrics_path: /metric'."\n" - .' static_configs:'."\n" - .' - targets:'."\n" - .' - 127.0.0.1:9090'."\n" - ."\n" - .'Probe example:'."\n" - ."\n" - .' apiVersion: monitoring.coreos.com/v1'."\n" - .' kind: Probe'."\n" - .' metadata:'."\n" - .' name: name1-tcp-blackbox #Rule: xxx-{tcp/http/ping}-blackbox'."\n" - .' namespace: arms-prom # Optional.'."\n" - .' spec:'."\n" - .' interval: 30s'."\n" - .' jobName: blackbox'."\n" - .' module: tcp_connect'."\n" - .' prober:'."\n" - .' path: /blackbox/probe'."\n" - .' scheme: http'."\n" - .' url: \'localhost:9335\''."\n" - .' targets:'."\n" - .' staticConfig:'."\n" - .' static:'."\n" - .' - \'arms-prom-admin.arms-prom:9335\''."\n", - ], - 'AppendInstancesToPrometheusGlobalView' => [ - 'summary' => 'Adds a data source to a global aggregation instance.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ResourceIdIsIllegal', 'errorMessage' => 'The specified ResourceId is invalid.', 'description' => 'The parameter ResourceId is illegal.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['errorCode' => 'AccountUidAccessError', 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetGrafanaWorkspace', + 'description' => 'Note: The list returned by this operation includes the workspaces of Developer Edition, Expert Edition, and Advanced Edition. The list does not include the workspaces of Shared Edition.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGrafanaWorkspace'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C3F217B-9AAE-5D51-974D-48********\\",\\n \\"Data\\": {\\n \\"status\\": \\"Starting、Running、Stop、DeleteSucceed\\",\\n \\"description\\": \\"线上生产环境Grafana\\",\\n \\"grafanaWorkspaceEdition\\": \\"personal_edition、experts_edition、advanced_edition、standard\\",\\n \\"endTime\\": 1652803200000,\\n \\"grafanaWorkspaceId\\": \\"grafana-cn-4xl3g******\\",\\n \\"upgradeVersion\\": [\\n \\"9.0.x\\"\\n ],\\n \\"grafanaWorkspaceIp\\": \\"47.110.71.***:443\\",\\n \\"snatIp\\": \\"47.110.71.***\\",\\n \\"grafanaWorkspaceDomain\\": \\"my-grafana.grafana.aliyuncs.com:443\\",\\n \\"grafanaWorkspaceDomainStatus\\": \\"on\\",\\n \\"commercial\\": true,\\n \\"grafanaWorkspaceName\\": \\"线上生产环境Grafana\\",\\n \\"grafanaVersion\\": \\"9.0.x\\",\\n \\"gmtCreate\\": 1642079398000,\\n \\"userId\\": \\"1412143830******\\",\\n \\"maxAccount\\": \\"10\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"protocol\\": \\"http、https\\",\\n \\"shareSynced\\": true,\\n \\"ntmId\\": \\"grafana-cn-4xl3g******\\",\\n \\"personalDomain\\": \\"my-grafana.grafana.aliyuncs.com:443\\",\\n \\"personalDomainPrefix\\": \\"my-grafana\\",\\n \\"resourceGroupId\\": \\"rg-aek2f4vzrfs6cla\\",\\n \\"deployType\\": \\"asi\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"TestKey\\",\\n \\"value\\": \\"TestValue\\"\\n }\\n ],\\n \\"privateIp\\": \\"192.168.1.1\\\\n\\",\\n \\"privateDomain\\": \\"my-grafana.grafana.aliyuncs.com:80\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\"\\n}","type":"json"}]', + ], + 'GetIntegrationState' => [ + 'summary' => 'Queries the integration state of the dashboards and collection rules of Application Real-Time Monitoring Service (ARMS) Prometheus.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -18387,292 +13115,209 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => true, - 'tenantRelevance' => 'publicInformation', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupName', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zyGlobalView', - ], + 'schema' => ['description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'Clusters', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The list of global aggregation instances. The value is a JSON string.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '\\[ { "sourceName": "Data source name- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId", }, { "sourceName": "Data source name - MetrcStore No.2", "sourceType":"MetricStore", "dataSource":"Remote read endpoint of the MetricStore", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"Remote read endpoint of the self-managed Prometheus data source", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"Endpoint of another data source such as Tencent remote read", "headers":{ "AnyHeaderToFill":"Headers to be filled" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]'."\n", - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GlobalViewClusterId', + 'name' => 'Integration', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'global-v2-cn-1670100631025794-6gjc0qgb', - ], + 'schema' => ['description' => 'The abbreviation of the software that is supported by ARMS. Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", 'type' => 'string', 'required' => true, 'example' => 'asm', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Response schema.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The information about the array object.'."\n", - 'type' => 'object', - 'properties' => [ - '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', - ], - 'Msg' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Info' => [ - 'description' => 'The Info-level information.'."\n", - 'type' => 'string', - 'example' => '{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedInstances: the ID of the object that failed to be added.}'."\n", - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Additional message.', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'State' => ['description' => 'The integration state of Prometheus dashboards and collection rules. Valid values:'."\n" + ."\n" + .'* `true`: The Prometheus dashboards and collection rules that monitor the software are integrated.'."\n" + .'* `false`: The Prometheus dashboards and collection rules that monitor the software are not integrated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 means success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The prompt information of the returned result.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'substitutions' => ['ARMS::2019-08-08::DescribeAddonRelease'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源JSON list中，添加失败的单个JSON的list}\\"\\n },\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AppendInstancesToPrometheusGlobalViewResponse>\\n <Data>\\n <Success>true</Success>\\n <Msg>OK</Msg>\\n <Info>{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源json list中，添加失败的单个json的list}</Info>\\n </Data>\\n <RequestId>27E653FA-5958-45BE-8AA9-14D884DC****</RequestId>\\n</AppendInstancesToPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'AppendInstancesToPrometheusGlobalView', - ], - 'AddPrometheusInstance' => [ - 'summary' => 'Creates a Prometheus instance for Remote Write.', - 'methods' => [ - 'post', - 'get', + 'title' => 'GetIntegrationState', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-21T03:12:11.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationState'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"State\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'GetManagedPrometheusStatus' => [ + 'summary' => 'Queries the installation status of a Prometheus agent in a serverless Kubernetes (ASK) cluster or an Elastic Compute Service (ECS) cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Prometheus instance for Remote Write.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'notificationpolicy_test', - ], + 'schema' => ['title' => '', 'description' => 'The cluster ID. This parameter is required if the ClusterType parameter is set to ask.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], ], [ - 'name' => 'Type', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The resource group id of the Prometheus instance.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****'], + ], + [ + 'name' => 'ClusterType', 'in' => 'query', 'schema' => [ - 'description' => 'The type of the Prometheus instance. Only Prometheus instances for Remote Write is supported. Set the value to RW.'."\n", + 'title' => '', + 'description' => 'The type of the cluster. Valid values: ask and ecs.'."\n", 'type' => 'string', 'required' => true, - 'example' => 'RW', + 'enumValueTitles' => ['acs' => 'acs', 'ecs' => 'ecs', 'one' => 'one', 'ask' => 'ask'], + 'example' => 'ask', ], ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the virtual private cloud (VPC). This parameter is required if the ClusterType parameter is set to ecs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-***'], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response format.'."\n", 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****'], 'Data' => [ - 'description' => 'The struct returned. { "RequestId": the request ID, "Data": "{ "clusterType": the cluster type, "remoteWriteUrl": the public URL for remote write, "internetGrafanaUrl": the internal URL for Grafana, "authToken": indicates whether authentication is enabled, "internetPushGatewayUrl": the internal URL for Pushgateway, "clusterId": the cluster ID, "internetRemoteReadUrl": the internal URL for remote read, "remoteReadUrl": the public URL for remote read, "grafanaUrl": the public URL for Grafana, "pushGatewayUrl": the public URL for Pushgateway, "internetRemoteWriteUrl": the internal URL for remote write}" }'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "RequestId": "1293091C-54AD-50FE-B787-E314B94B35AB",'."\n" - .' "Data": "{'."\n" - .' "clusterType":"remote-write-prometheus",'."\n" - .' "remoteWriteUrl":"http://cn-hu/api/v3/write",'."\n" - .' "internetGrafanaUrl":"https://cn-hanga/cn-hangzhou",'."\n" - .' "authToken":false,'."\n" - .' "internetPushGatewayUrl":"https://cangzhou/api/v2",'."\n" - .' "clusterId":"vrju1lj3sa|123456",'."\n" - .' "internetRemoteReadUrl":"https://cn-hangzh67cn-hangzhou/api/v1/read",'."\n" - .' "remoteReadUrl":"http://cn-hanou/api/v1/read",'."\n" - .' "grafanaUrl":"http://cn-angzhou",'."\n" - .' "pushGatewayUrl":"htt1lj3sa/cn-hangzhou/api/v2",'."\n" - .' "internetRemoteWriteUrl":"httpsngzhou/api/v3/write"}"'."\n" - .'}', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", + 'description' => 'The installation status of the Prometheus agent.'."\n" + ."\n" + .'* Installing: The Prometheus agent is installed and no registration information is available.'."\n" + .'* Succeed: The Prometheus agent is installed and registered.'."\n" + .'* Failure: The Prometheus agent failed to be installed or registered.'."\n" + .'* Unknown: The installation status of the Prometheus agent is unknown.'."\n", 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'enumValueTitles' => ['Unknown' => 'Unknown', 'Installing' => 'Installing', 'Failure' => 'Failure', 'Succeed' => 'Succeed'], + 'example' => 'Installing', + 'title' => '', ], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '查询成功', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::CreatePrometheusInstance', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"1293091C-54AD-50FE-B787-E314B94B35AB\\\\\\",\\\\n \\\\\\"Data\\\\\\": \\\\\\"{\\\\n \\\\\\"clusterType\\\\\\":\\\\\\"remote-write-prometheus\\\\\\",\\\\n \\\\\\"remoteWriteUrl\\\\\\":\\\\\\"http://cn-hu/api/v3/write\\\\\\",\\\\n \\\\\\"internetGrafanaUrl\\\\\\":\\\\\\"https://cn-hanga/cn-hangzhou\\\\\\",\\\\n \\\\\\"authToken\\\\\\":false,\\\\n \\\\\\"internetPushGatewayUrl\\\\\\":\\\\\\"https://cangzhou/api/v2\\\\\\",\\\\n \\\\\\"clusterId\\\\\\":\\\\\\"vrju1lj3sa|123456\\\\\\",\\\\n \\\\\\"internetRemoteReadUrl\\\\\\":\\\\\\"https://cn-hangzh67cn-hangzhou/api/v1/read\\\\\\",\\\\n \\\\\\"remoteReadUrl\\\\\\":\\\\\\"http://cn-hanou/api/v1/read\\\\\\",\\\\n \\\\\\"grafanaUrl\\\\\\":\\\\\\"http://cn-angzhou\\\\\\",\\\\n \\\\\\"pushGatewayUrl\\\\\\":\\\\\\"htt1lj3sa/cn-hangzhou/api/v2\\\\\\",\\\\n \\\\\\"internetRemoteWriteUrl\\\\\\":\\\\\\"httpsngzhou/api/v3/write\\\\\\"}\\\\\\"\\\\n}\\",\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'AddPrometheusInstance', - ], - 'AddPrometheusGlobalViewByAliClusterIds' => [ - 'summary' => 'Adds a global aggregation instance in Managed Service for Prometheus.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'title' => 'GetManagedPrometheusStatus', + 'changeSet' => [ + ['createdAt' => '2023-11-13T11:34:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-15T03:15:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-28T11:41:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-28T11:41:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-25T15:24:30.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetManagedPrometheusStatus'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Data\\": \\"Installing\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"查询成功\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'GetMultipleTrace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'TraceIDs', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The name of the global aggregation instance.'."\n", - 'type' => 'string', + 'description' => 'The trace IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The trace ID. You can specify one to nine trace IDs. You can log on to the Application Real-Time Monitoring Service (ARMS) console and obtain the trace ID on the **Trace Query** page.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ac1400a115951745017447033d****', 'title' => ''], 'required' => true, - 'docRequired' => true, - 'example' => 'zyGlobalView', + 'example' => 'ac1400a115951745017447033d****', + 'maxItems' => 10, + 'title' => '', ], ], [ - 'name' => 'ProductCode', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The identifier to identify the service if custom dashboards are created for the specified clusters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'adcp', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the trace. The value is a timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1657692507000'], ], [ - 'name' => 'ClusterIds', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of clusters. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', - ], + 'schema' => ['title' => '', 'description' => 'The time when the trace ends. The value is a timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1663999380000'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Default value: `1`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return per page, the maximum value is 1000.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ @@ -18680,292 +13325,374 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Msg' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Info' => [ - 'description' => 'The Info-level information.'."\n", - 'type' => 'string', - 'example' => '{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedClusterIds: the ID of the cluster that failed to be added. A cluster may fail to be added because the specified cluster ID is invalid or the cluster is added across continents.}'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', 'title' => ''], + 'MultiCallChainInfos' => [ + 'description' => 'The details of traces.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TraceID' => ['description' => 'The trace ID.'."\n", 'type' => 'string', 'example' => 'ac1400a115951745017447033d****', 'title' => ''], + 'Spans' => [ + 'description' => 'The details of the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SpanId' => ['description' => 'The span ID.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'OperationName' => ['description' => 'The name of the traced span.'."\n", 'type' => 'string', 'example' => '/demo/queryNotExistDB/11', 'title' => ''], + 'ResultCode' => ['description' => 'The status code returned.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1595174501747', 'title' => ''], + 'RpcType' => ['description' => 'The type of the remote procedure call (RPC) mode.'."\n" + ."\n" + .'* 0: HTTP entry'."\n" + .'* 25: HTTP call'."\n" + .'* 1: High-speed Service Framework (HSF) call'."\n" + .'* 2: HSF provision'."\n" + .'* 40: on-premises API call'."\n" + .'* 60: MySQL call'."\n" + .'* 62: Oracle call'."\n" + .'* 63: PostgreSQL call'."\n" + .'* 70: Redis call'."\n" + .'* 4: Taobao Distributed Data Layer (TDDL) call'."\n" + .'* 5: Tair call'."\n" + .'* 13: MetaQ message sending'."\n" + .'* 252: MetaQ message receiving'."\n" + .'* 3: notification sending'."\n" + .'* 254: notification receiving'."\n" + .'* 7: Apache Dubbo call'."\n" + .'* 8: Apache Dubbo provision'."\n" + .'* 19: SOFARPC call'."\n" + .'* 18: SOFARPC provision'."\n" + .'* 11: Distributed Service Framework (DSF) call'."\n" + .'* 12: DSF provision'."\n" + .'* \\-1: unknown call'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ServiceIp' => ['description' => 'The IP address of the host where the application resides.'."\n", 'type' => 'string', 'example' => '172.20.XX.XX', 'title' => ''], + 'HaveStack' => ['description' => 'Indicates whether a method stack was provided.'."\n" + ."\n" + .'* `true`: A method stack was provided.'."\n" + .'* `false`: No method stack was provided.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'ParentSpanId' => ['description' => 'The ID of the parent span.'."\n", 'type' => 'string', 'example' => '18', 'title' => ''], + 'Duration' => ['description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11', 'title' => ''], + 'RpcId' => ['description' => 'RPC ID'."\n", 'type' => 'string', 'example' => '0.1', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'arms-k8s-demo-subcomponent', 'title' => ''], + 'TraceID' => ['description' => 'The trace ID.'."\n", 'type' => 'string', 'example' => 'ac1400a115951745017447033d****', 'title' => ''], + 'TagEntryList' => [ + 'description' => 'The tags of the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'http.status.code', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LogEventList' => [ + 'description' => 'The log events in the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => 'The time when the log was generated. The value is a timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1595174501747', 'title' => ''], + 'TagEntryList' => [ + 'description' => 'The tags of the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'http.status.code', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9', - ], - 'Code' => [ - 'description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"success\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}\\"\\n },\\n \\"RequestId\\": \\"3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddPrometheusGlobalViewByAliClusterIdsResponse>\\n <Data>\\n <Success>true</Success>\\n <Msg>success</Msg>\\n <Info>{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}</Info>\\n </Data>\\n <RequestId>3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9</RequestId>\\n</AddPrometheusGlobalViewByAliClusterIdsResponse>","errorExample":""}]', - 'title' => 'AddPrometheusGlobalViewByAliClusterIds', - ], - 'AddPrometheusGlobalView' => [ - 'summary' => 'Adds a global aggregation instance in Prometheus Service.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"MultiCallChainInfos\\": [\\n {\\n \\"TraceID\\": \\"ac1400a115951745017447033d****\\",\\n \\"Spans\\": [\\n {\\n \\"SpanId\\": \\"1234\\",\\n \\"OperationName\\": \\"/demo/queryNotExistDB/11\\",\\n \\"ResultCode\\": \\"1\\",\\n \\"Timestamp\\": 1595174501747,\\n \\"RpcType\\": 0,\\n \\"ServiceIp\\": \\"172.20.XX.XX\\",\\n \\"HaveStack\\": true,\\n \\"ParentSpanId\\": \\"18\\",\\n \\"Duration\\": 11,\\n \\"RpcId\\": \\"0.1\\",\\n \\"ServiceName\\": \\"arms-k8s-demo-subcomponent\\",\\n \\"TraceID\\": \\"ac1400a115951745017447033d****\\",\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ],\\n \\"LogEventList\\": [\\n {\\n \\"Timestamp\\": 1595174501747,\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetMultipleTraceResponse>\\n\\t<RequestId>2983BEF7-4A0D-47A2-94A2-8E9C5E63****</RequestId>\\n\\t<MultiCallChainInfos>\\n\\t\\t<TraceID>ac1400a115951745017447033d****</TraceID>\\n\\t\\t<Spans>\\n\\t\\t\\t<HaveStack>true</HaveStack>\\n\\t\\t\\t<ServiceIp>172.20.XX.XX</ServiceIp>\\n\\t\\t\\t<OperationName>/demo/queryNotExistDB/11</OperationName>\\n\\t\\t\\t<ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n\\t\\t\\t<RpcId>0.1</RpcId>\\n\\t\\t\\t<RpcType>0</RpcType>\\n\\t\\t\\t<TraceID>ac1400a115951745017447033d****</TraceID>\\n\\t\\t\\t<Duration>11</Duration>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>200</Value>\\n\\t\\t\\t\\t<Key>http.status.code</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>172.20.XX.XX</Value>\\n\\t\\t\\t\\t<Key>source.ip</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<Timestamp>1595174501747</Timestamp>\\n\\t\\t\\t<ResultCode>1</ResultCode>\\n\\t\\t</Spans>\\n\\t</MultiCallChainInfos>\\n\\t<MultiCallChainInfos>\\n\\t\\t<TraceID>ac1400a115951745017577035d****</TraceID>\\n\\t\\t<Spans>\\n\\t\\t\\t<HaveStack>true</HaveStack>\\n\\t\\t\\t<ServiceIp>172.20.XX.XX</ServiceIp>\\n\\t\\t\\t<OperationName>/demo/queryException/12</OperationName>\\n\\t\\t\\t<ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n\\t\\t\\t<RpcId>0.1</RpcId>\\n\\t\\t\\t<RpcType>0</RpcType>\\n\\t\\t\\t<TraceID>ac1400a115951745017577035d****</TraceID>\\n\\t\\t\\t<Duration>2</Duration>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>500</Value>\\n\\t\\t\\t\\t<Key>http.status.code</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<TagEntryList>\\n\\t\\t\\t\\t<Value>172.20.XX.XX</Value>\\n\\t\\t\\t\\t<Key>source.ip</Key>\\n\\t\\t\\t</TagEntryList>\\n\\t\\t\\t<Timestamp>1595174501761</Timestamp>\\n\\t\\t\\t<ResultCode>1</ResultCode>\\n\\t\\t</Spans>\\n\\t</MultiCallChainInfos>\\n</GetMultipleTraceResponse>","errorExample":""}]', + 'title' => 'GetMultipleTrace', + 'summary' => 'Queries the details of one or more traces.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-21T07:06:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-16T03:13:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-21T11:57:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-15T12:40:35.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetOnCallSchedulesDetail' => [ + 'summary' => 'Use the GetOnCallSchedulesDetail API to retrieve the details of an on-call schedule.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zyGlobalView', - ], - ], - [ - 'name' => 'Clusters', + 'name' => 'Id', 'in' => 'query', - 'schema' => [ - 'description' => 'The queried global aggregation instances. The value is a JSON string.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[ { "sourceName": "Data source name- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId", }, { "sourceName": "Data source name - MetrcStore No.2", "sourceType":"MetricStore", "dataSource":"MetricStore remote read address", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Custom ", "sourceType":"CustomPrometheus", "dataSource":"Build your own Prometheus data source remoteread address", "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } }, { "sourceName": "Other one ", "sourceType":"Others", "dataSource":"Other data sources such as Tencent remoteread address", "headers":{ "AnyHeaderToFill":"Headers to be populated" }, "extras":{ "username":"BasicAuthUsername", "password":"BasicAuthPassword" } } // ....... more addre ]', - ], + 'schema' => ['title' => 'The ID of the scheduled user.'."\n", 'description' => 'The ID of the on-call schedule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2eq4pecazwfy', - ], + 'schema' => ['title' => 'The information about the substitute.'."\n", 'description' => 'The start date of the query range in `yyyy-MM-dd` format.', 'type' => 'string', 'example' => '2022-10-01', 'required' => false], ], [ - 'name' => 'Tag', + 'name' => 'EndTime', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag that you want to add.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http.status_code', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['title' => 'The ID of the scheduling policy.'."\n", 'description' => 'The end date of the query range in `yyyy-MM-dd` format.', 'type' => 'string', 'example' => '2022-10-30', 'required' => false], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response data.', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'The date on which the user completed shift work.'."\n", 'description' => 'The request ID.', 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****'], 'Data' => [ - 'description' => 'The information about the array object.'."\n", + 'title' => 'The date from which the shift starts. Format: `yyyy-MM-dd`.'."\n", + 'description' => 'The details of the on-call schedule.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Msg' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => 'OK', + 'Id' => ['title' => 'The ID list of users on duty.'."\n", 'description' => 'The ID of the on-call schedule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => 'The information about the user on duty.'."\n", 'description' => 'The name of the on-call schedule.', 'type' => 'string', 'example' => '排班策略测试'], + 'Description' => ['title' => 'The date on which the substitute was supposed to complete shift work.'."\n", 'description' => 'The description of the on-call schedule.', 'type' => 'string', 'example' => '测试'], + 'AlertRobotId' => ['description' => 'The webhook URL of the DingTalk bot for rotation notifications.', 'type' => 'integer', 'format' => 'int64', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******', 'title' => ''], + 'ScheduleLayers' => [ + 'description' => 'A list of schedule layers.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactIds' => [ + 'description' => 'A list of contact IDs for the schedule layer.', + 'type' => 'array', + 'items' => ['description' => 'A contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '[123, 234, 456]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'StartTime' => ['description' => 'The start time for the rotation.', 'type' => 'string', 'example' => '2022-10-01'."\n", 'title' => ''], + 'ShiftLength' => ['description' => 'The shift length for the rotation, in hours.', 'type' => 'integer', 'format' => 'int64', 'example' => '8', 'title' => ''], + 'RotationType' => ['description' => 'The rotation type. Valid values:'."\n" + ."\n" + .'- `DAY`: Rotates every day.'."\n" + ."\n" + .'- `WEEK`: Rotates every week.'."\n" + ."\n" + .'- `CUSTOM`: Rotates based on a custom schedule.', 'type' => 'string', 'example' => 'DAY', 'title' => ''], + 'Restrictions' => [ + 'description' => 'A list of restrictions for the schedule layer.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestrictionType' => ['description' => 'The type of restriction. Valid values:'."\n" + ."\n" + .'- `daily_restriction`: A daily time-based restriction.'."\n" + ."\n" + .'- `weekly_restriction`: A weekly time-based restriction.', 'type' => 'string', 'example' => 'daily_restriction', 'title' => ''], + 'StartTimeOfDay' => ['description' => 'The start time for on-call duty each day.', 'type' => 'string', 'example' => '09:00', 'title' => ''], + 'EndTimeOfDay' => ['description' => 'The end time for on-call duty each day.', 'type' => 'string', 'example' => '18:00', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Info' => [ - 'description' => 'The Info-level information.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', + 'RenderedLayerEntries' => [ + 'description' => 'A list of contacts on duty within the specified time range, as defined by the schedule layers.', + 'type' => 'array', + 'items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => ['description' => 'The start time of the on-call duty for the contact.', 'type' => 'string', 'example' => '2022-10-01', 'title' => ''], + 'End' => ['description' => 'The end time of the on-call duty for the contact.', 'type' => 'string', 'example' => '2022-10-30', 'title' => ''], + 'SimpleContact' => [ + 'description' => 'Details of the on-duty contact.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Name' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '员工1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'GlobalViewClusterId' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'example' => 'global-v2-cn-1483223059272121-jmjjfznz', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RenderedSubstitudeEntries' => [ + 'description' => 'A list of substitutes scheduled within the specified time range.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => ['description' => 'The start time of the on-call duty for the substitute.', 'type' => 'string', 'example' => '2022-10-01', 'title' => ''], + 'End' => ['description' => 'The end time of the on-call duty for the substitute.', 'type' => 'string', 'example' => '2022-10-30', 'title' => ''], + 'SimpleContact' => [ + 'description' => 'Details of the substitute.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The substitute ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '234', 'title' => ''], + 'Name' => ['description' => 'The substitute name.', 'type' => 'string', 'example' => '员工2', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], - 'FailedInstances' => [ - 'description' => 'The list of instances that failed to be added.'."\n", - 'type' => 'string', - 'example' => '\\[{"sourceName": "Data source name- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]'."\n", + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'RenderedFinnalEntries' => [ + 'description' => 'The final list of on-call contacts, after accounting for all rotations and substitutions.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => ['description' => 'The start time of the on-call duty for the contact.', 'type' => 'string', 'example' => '2022-10-01', 'title' => ''], + 'End' => ['description' => 'The end time of the on-call duty for the contact.', 'type' => 'string', 'example' => '2022-10-30', 'title' => ''], + 'SimpleContact' => [ + 'description' => 'Details of the final on-call contact.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The contact ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Name' => ['description' => 'The contact name.', 'type' => 'string', 'example' => '员工1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', 'example' => '', ], ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'Code' => [ - 'description' => '状态码。说明 200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回结果的提示信息。', - 'type' => 'string', - 'example' => 'success', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'title' => 'GetOnCallSchedulesDetail', + 'changeSet' => [ + ['createdAt' => '2022-07-26T12:38:43.000Z', 'description' => 'OpenAPI offline'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"GlobalViewClusterId\\": \\"global-v2-cn-1483223059272121-jmjjfznz\\",\\n \\"FailedInstances\\": \\"[{\\\\\\"sourceName\\\\\\": \\\\\\"数据源名称- ArmsPrometheus\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"UserID\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"ClusterId\\\\\\",}]\\"\\n }\\n },\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddPrometheusGlobalViewResponse>\\n <Data>\\n <Success>true</Success>\\n <Msg>OK</Msg>\\n <Info>{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源json list中，添加失败的单个json的list}</Info>\\n </Data>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n</AddPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'AddPrometheusGlobalView', - ], - 'AddAliClusterIdsToPrometheusGlobalView' => [ - 'summary' => 'Adds a global aggregation instance as a data source in Managed Service for Prometheus.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnCallSchedulesDetail'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetOnCallSchedulesDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Data\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"排班策略测试\\",\\n \\"Description\\": \\"测试\\",\\n \\"AlertRobotId\\": 0,\\n \\"ScheduleLayers\\": [\\n {\\n \\"ContactIds\\": [\\n 0\\n ],\\n \\"StartTime\\": \\"2022-10-01\\\\n\\",\\n \\"ShiftLength\\": 8,\\n \\"RotationType\\": \\"DAY\\",\\n \\"Restrictions\\": [\\n {\\n \\"RestrictionType\\": \\"daily_restriction\\",\\n \\"StartTimeOfDay\\": \\"09:00\\",\\n \\"EndTimeOfDay\\": \\"18:00\\"\\n }\\n ]\\n }\\n ],\\n \\"RenderedLayerEntries\\": [\\n [\\n {\\n \\"Start\\": \\"2022-10-01\\",\\n \\"End\\": \\"2022-10-30\\",\\n \\"SimpleContact\\": {\\n \\"Id\\": 123,\\n \\"Name\\": \\"员工1\\"\\n }\\n }\\n ]\\n ],\\n \\"RenderedSubstitudeEntries\\": [\\n {\\n \\"Start\\": \\"2022-10-01\\",\\n \\"End\\": \\"2022-10-30\\",\\n \\"SimpleContact\\": {\\n \\"Id\\": 234,\\n \\"Name\\": \\"员工2\\"\\n }\\n }\\n ],\\n \\"RenderedFinnalEntries\\": [\\n {\\n \\"Start\\": \\"2022-10-01\\",\\n \\"End\\": \\"2022-10-30\\",\\n \\"SimpleContact\\": {\\n \\"Id\\": 123,\\n \\"Name\\": \\"员工1\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'GetPrometheusApiToken' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zyGlobalView', - ], - ], - [ - 'name' => 'GlobalViewClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', - ], - ], - [ - 'name' => 'ClusterIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of clusters. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -18973,879 +13700,847 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The information about the array object.'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Msg' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Info' => [ - 'description' => 'The Info-level information.'."\n", - 'type' => 'string', - 'example' => '{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance. failedClusterIds: the ID of the cluster that failed to be added. A cluster may fail to be added because the specified cluster ID is invalid or the cluster is added across continents.}'."\n", - ], - ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - 'Code' => [ - 'description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Token' => ['description' => 'The token required for integrating Prometheus Service.'."\n", 'type' => 'string', 'example' => '6dcbb77ef4ba6ef5466b5debf9e2****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}\\"\\n },\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddAliClusterIdsToPrometheusGlobalViewResponse>\\n <Data>\\n <Success>true</Success>\\n <Msg>OK</Msg>\\n <Info>{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}</Info>\\n </Data>\\n <RequestId>F7781D4A-2818-41E7-B7BB-79D809E9****</RequestId>\\n</AddAliClusterIdsToPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'AddAliClusterIdsToPrometheusGlobalView', - ], - 'AddRecordingRule' => [ - 'summary' => 'Creates or updates a recording rule.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Token\\": \\"6dcbb77ef4ba6ef5466b5debf9e2****\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPrometheusApiTokenResponse>\\n\\t<RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n\\t<Token>6dcbb77ef4ba6ef5466b5debf9e2****</Token>\\n</GetPrometheusApiTokenResponse>","errorExample":""}]', + 'title' => 'GetPrometheusApiToken', + 'summary' => 'Queries the token required for integrating Prometheus Service.', + 'description' => 'None.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-03-20T08:09:25.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusApiToken'], + ], ], + 'ramActions' => [], + ], + 'GetPrometheusGlobalView' => [ + 'summary' => 'Queries the information about a global aggregation instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RuleYaml', + 'name' => 'GlobalViewClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The custom recording rule. The value is in the YAML format.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'groups: - name: "recording_demo" rules: - expr: "sum(jvm_memory_max_bytes)" record: "rate_coredns_demo"', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The schema of the response.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'Data' => [ - 'description' => 'The status of the response.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code. 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', - ], + 'Data' => ['description' => 'The struct returned.'."\n", 'type' => 'string', 'example' => '{ "clusterId":"聚合实例ClusterId", "groupName":"聚合实例名称", "dataSources":[ { "sourceName":"数据源名称- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId" }, // more datasources ] }', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '743AD493-D006-53BD-AAEC-DDCE7FB68EA7', 'title' => ''], + 'Code' => ['description' => 'Status code. 200 is success, other status codes are exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'Returns a hint message for the result.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"Data\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddRecordingRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <Data>success</Data>\\n</AddRecordingRuleResponse>","errorExample":""}]', - 'title' => 'AddRecordingRule', - ], - 'SyncRecordingRules' => [ - 'summary' => 'Synchronizes the aggregation rule of a cluster to other clusters in a region.', - 'methods' => [ - 'get', - 'post', + 'title' => 'GetPrometheusGlobalView', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusGlobalView'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{ \\\\\\"clusterId\\\\\\":\\\\\\"聚合实例ClusterId\\\\\\", \\\\\\"groupName\\\\\\":\\\\\\"聚合实例名称\\\\\\", \\\\\\"dataSources\\\\\\":[ { \\\\\\"sourceName\\\\\\":\\\\\\"数据源名称- ArmsPrometheus No.1\\\\\\", \\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\", \\\\\\"userId\\\\\\":\\\\\\"UserID\\\\\\", \\\\\\"clusterId\\\\\\":\\\\\\"ClusterId\\\\\\" }, // more datasources ] }\\",\\n \\"RequestId\\": \\"743AD493-D006-53BD-AAEC-DDCE7FB68EA7\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'GetPrometheusInstance' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '163198', + 'abilityTreeNodes' => ['FEATUREarmsFRX7PL'], + 'tenantRelevance' => 'tenant', ], 'parameters' => [ [ - 'name' => 'ClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster whose aggregation rule you want to synchronize.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TargetClusters', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of clusters to which you want to synchronize the aggregation rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "cn":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***" ], "us":[ "ce30f833bc4a04a56a06b070319***" ], "jp":[ ], "ap":[ ], "gov":[ ], "finance":[ ] }', - ], - ], - [ - 'name' => 'RegionId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. The destination region can be the same as the source region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The Prometheus instance ID.', 'type' => 'string', 'required' => true, 'example' => 'c77f6f2397ea74672872acf5e31374a27', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', + 'title' => '', 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '52C422FD-6B43-524D-B8A1-A4693294318C'], + 'Message' => ['description' => 'The message returned for the result.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success. Other values indicate errors.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'string', - 'example' => '{ "data":\\[ "c06ca68cd16f14f52bb07772eda\\*\\*\\*", "c33dd70a0ac184c1b879d807ab2\\*\\*\\*", "c384cf7e4dcb543e6ac8c7d4dd3\\*\\*\\*", "ce30f833bc4a04a56a06b070319\\*\\*\\*" ], "message":"IDs of Clusters to which the aggregation rule failed to be synchronized", "success":true }'."\n", - ], - 'Code' => [ - 'description' => '状态码。200表示成功。', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '返回结果的提示信息。', - 'type' => 'string', - 'example' => 'success', + 'description' => 'The returned information.', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The Prometheus instance ID.', 'type' => 'string', 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '167275301789****', 'title' => ''], + 'ClusterName' => ['description' => 'The cluster name.', 'type' => 'string', 'example' => 'prom1', 'title' => ''], + 'ClusterType' => ['title' => '', 'description' => '- remote-write (Prometheus for Remote Write)'."\n" + .'- ecs (Prometheus for ECS)'."\n" + .'- cloud-monitor (Prometheus for Cloud Service in the Chinese mainland)'."\n" + .'- cloud-product (Prometheus for Cloud Service outside the Chinese mainland)'."\n" + .'- global-view (Prometheus for GlobalView)'."\n" + .'- aliyun-cs (Prometheus for Container Service).', 'type' => 'string', 'example' => 'remote-write'], + 'VpcId' => ['description' => 'The VPC associated with the cluster. This parameter is returned only for Prometheus for ECS instances.', 'type' => 'string', 'example' => 'vpc-8vb02uk57qbcktqcvqqqj', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID. This parameter is returned only for Prometheus for ECS instances.', 'type' => 'string', 'example' => 'vsw-f8z73vcja1tqnw90aav5a', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The security group ID. This parameter is returned only for Prometheus for ECS instances.', 'type' => 'string', 'example' => 'sg-8vbdgmf4nraiqa9bx0jo', 'title' => ''], + 'SubClustersJson' => ['title' => '', 'description' => 'The JSON string of sub-instances for the GlobalView instance.', 'type' => 'string', 'example' => '[{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73***","sourceName":"arms-luyao-test","dataSource":"","userId":"167275301789***"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5****","sourceName":"agent-321-测试","dataSource":"","userId":"1672753017899***"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"167275301789***"}]'], + 'RemoteReadIntraUrl' => ['description' => 'The internal endpoint for remote read.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', 'title' => ''], + 'RemoteReadInterUrl' => ['description' => 'The public endpoint for remote read.', 'type' => 'string', 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', 'title' => ''], + 'RemoteWriteIntraUrl' => ['description' => 'The internal endpoint for remote write.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write', 'title' => ''], + 'RemoteWriteInterUrl' => ['description' => 'The public endpoint for remote write.', 'type' => 'string', 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write', 'title' => ''], + 'PushGatewayIntraUrl' => ['description' => 'The internal endpoint for push gateway.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2', 'title' => ''], + 'PushGatewayInterUrl' => ['description' => 'The public endpoint for push gateway.', 'type' => 'string', 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2', 'title' => ''], + 'OpenTelemetryInterUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'HttpApiIntraUrl' => ['description' => 'The internal endpoint for HTTP API.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx', 'title' => ''], + 'HttpApiInterUrl' => ['description' => 'The public endpoint for HTTP API.', 'type' => 'string', 'example' => 'https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx', 'title' => ''], + 'AuthToken' => ['description' => 'The authorization token string.', 'type' => 'string', 'example' => 'GciOiJIUzI1NiJ9***', 'title' => ''], + 'AccessType' => ['title' => '', 'description' => 'The permission type. Valid values:'."\n" + ."\n" + .'- readWrite'."\n" + .'- readOnly'."\n" + .'- httpReadOnly.', 'type' => 'string', 'example' => 'readWrite'], + 'PaymentType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- PREPAY: subscription.'."\n" + .'- POSTPAY: pay-as-you-go.', 'type' => 'string', 'example' => 'PREPAY', 'title' => ''], + 'StorageDuration' => ['title' => '', 'description' => 'The storage duration, in days.', 'type' => 'integer', 'format' => 'int32', 'example' => '90'], + 'ArchiveDuration' => ['title' => '', 'description' => 'The number of days that data is automatically archived after the storage period expires. Valid values: 60, 90, 180, and 365. A value of 0 indicates that data is not archived.', 'type' => 'integer', 'format' => 'int32', 'example' => '60'], + 'GrafanaInstanceId' => ['description' => 'The Grafana workspace ID.', 'type' => 'string', 'example' => 'grafana-rnggfvhlcdl6m71***', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the instance belongs.', 'type' => 'string', 'example' => 'rg-aek2vezare****', 'title' => ''], + 'ResourceType' => ['title' => '', 'description' => 'The fixed value: PROMETHEUS.', 'type' => 'string', 'example' => 'PROMETHEUS'], + 'EnableAuthToken' => ['title' => '', 'description' => 'Indicates whether access token authentication is enabled.', 'type' => 'string', 'example' => 'true'], + 'SupportAuthTypes' => [ + 'description' => 'The supported authentication types.', + 'type' => 'array', + 'items' => [ + 'description' => 'The supported authentication types.', + 'enumValueTitles' => ['BasicAuth' => 'HTTP basic authentication.', 'AuthFree' => 'Authentication-free access.', 'AuthToken' => 'Token-based authentication.'], + 'type' => 'string', + 'example' => 'AuthFree', + 'title' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EnableAuthFreeRead' => ['title' => '', 'description' => 'Indicates whether authentication-free read access is enabled.', 'type' => 'boolean', 'example' => ''], + 'AuthFreeReadPolicy' => ['title' => '', 'description' => 'The whitelist policy for authentication-free read access.', 'type' => 'string', 'example' => '0.0.0.0/0'], + 'EnableAuthFreeWrite' => ['title' => '', 'description' => 'Indicates whether authentication-free write access is enabled.', 'type' => 'boolean', 'example' => ''], + 'AuthFreeWritePolicy' => ['title' => '', 'description' => 'The whitelist policy for authentication-free write access.', 'type' => 'string', 'example' => '0.0.0.0/0'], + 'Product' => ['title' => '', 'description' => 'The product to which the Prometheus instance belongs (arms or cms).', 'type' => 'string', 'example' => 'arms'], + 'DbInstanceStatus' => ['title' => '', 'description' => 'The status of the backend data storage.', 'type' => 'string', 'example' => 'RUNNING'], + 'Version' => ['title' => '', 'description' => 'The version.', 'type' => 'string', 'example' => 'V1'], + 'PaymentTypeUpdateTime' => ['title' => '', 'description' => 'The time when the billing method of the instance was last modified.', 'type' => 'string', 'example' => '2025-02-26T06:05:01Z'], + 'ExtraInfo' => [ + 'title' => '', + 'description' => 'The extended information. This parameter is returned only for console requests.', + 'type' => 'object', + 'additionalProperties' => ['description' => '扩展信息。', 'type' => 'string', 'example' => 'extraKey', 'title' => ''], + 'example' => '', + ], + 'Tags' => [ + 'description' => 'The tags bound to the instance.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'tag1', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'tagValue1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'OpenTelemetryIntraUrl' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve specified prometheus instance information', + 'summary' => 'Retrieves information about a specified Prometheus instance.', + 'changeSet' => [ + ['createdAt' => '2025-05-21T04:08:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-13T07:36:22.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-12-05T01:37:43.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-06T10:02:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-02T01:49:53.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-15T08:21:18.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-02T02:19:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-28T08:10:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-27T09:16:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-04-12T03:44:15.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-06T01:50:01.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"{ \\\\\\"data\\\\\\":[ \\\\\\"c06ca68cd16f14f52bb07772eda***\\\\\\", \\\\\\"c33dd70a0ac184c1b879d807ab2***\\\\\\", \\\\\\"c384cf7e4dcb543e6ac8c7d4dd3***\\\\\\", \\\\\\"ce30f833bc4a04a56a06b070319***\\\\\\" ], \\\\\\"message\\\\\\":\\\\\\"设置RecordingRule失败的clusterIds\\\\\\", \\\\\\"success\\\\\\":true }\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<SyncRecordingRulesResponse>\\n <RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n <Data>{ \\"data\\":[ \\"c06ca68cd16f14f52bb07772eda***\\", \\"c33dd70a0ac184c1b879d807ab2***\\", \\"c384cf7e4dcb543e6ac8c7d4dd3***\\", \\"ce30f833bc4a04a56a06b070319***\\" ], \\"message\\":\\"设置RecordingRule失败的clusterIds\\", \\"success\\":true }</Data>\\n</SyncRecordingRulesResponse>","errorExample":""}]', - 'title' => 'SyncRecordingRules', - 'requestParamsDescription' => 'Note: The **TargetClusters** parameter specifies the clusters to which aggregation rule is synchronized. You must pass the parameter in the JSON format. Each element in the TargetClusters parameter is an array, which indicates a cluster ID. Example: { "cn":\\[], //China "eu":\\[], //Europe "us":\\[], //America "jp":\\[], //Japan "ap":\\[], //Asia Pacific "gov":\\[], //Alibaba Gov Cloud "finance":\\[] //Alibaba Finance Cloud }. Enter cluster IDs in each pair of brackets (\\[]).'."\n", - 'responseParamsDescription' => 'Note: If the value of the response parameter **Data** is true, the call is successful. Otherwise, the call fails. If the value of the data field is not null, the aggregation rule fails to be synchronized to some clusters. The error may occur due to cluster faults or request timeout. You need to check and troubleshoot the error before you call the API operation again.'."\n", - ], - 'AddIntegration' => [ - 'summary' => 'Integrates the dashboard and collection rules of Prometheus Service.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52C422FD-6B43-524D-B8A1-A4693294318C\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"ClusterId\\": \\"c589a1b8db05c4561aefbb898ca8fb1cf\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"UserId\\": \\"167275301789****\\",\\n \\"ClusterName\\": \\"prom1\\",\\n \\"ClusterType\\": \\"remote-write\\",\\n \\"VpcId\\": \\"vpc-8vb02uk57qbcktqcvqqqj\\",\\n \\"VSwitchId\\": \\"vsw-f8z73vcja1tqnw90aav5a\\",\\n \\"SecurityGroupId\\": \\"sg-8vbdgmf4nraiqa9bx0jo\\",\\n \\"SubClustersJson\\": \\"[{\\\\\\"headers\\\\\\":{},\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"extras\\\\\\":{},\\\\\\"clusterId\\\\\\":\\\\\\"c39a1048921e04fceb039db2fbb73***\\\\\\",\\\\\\"sourceName\\\\\\":\\\\\\"arms-luyao-test\\\\\\",\\\\\\"dataSource\\\\\\":\\\\\\"\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"167275301789***\\\\\\"},{\\\\\\"headers\\\\\\":{},\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"extras\\\\\\":{},\\\\\\"clusterId\\\\\\":\\\\\\"c6b6485496d5b400abde22cb47b5****\\\\\\",\\\\\\"sourceName\\\\\\":\\\\\\"agent-321-测试\\\\\\",\\\\\\"dataSource\\\\\\":\\\\\\"\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"1672753017899***\\\\\\"},{\\\\\\"headers\\\\\\":{},\\\\\\"regionId\\\\\\":\\\\\\"cn-zhangjiakou\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"extras\\\\\\":{},\\\\\\"clusterId\\\\\\":\\\\\\"c261a4f3200c446659133f1ade789b15e\\\\\\",\\\\\\"sourceName\\\\\\":\\\\\\"zaifeng-cardinality-01\\\\\\",\\\\\\"dataSource\\\\\\":\\\\\\"\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"167275301789***\\\\\\"}]\\",\\n \\"RemoteReadIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteReadInterUrl\\": \\"http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteWriteIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"RemoteWriteInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"PushGatewayIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"PushGatewayInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"OpenTelemetryInterUrl\\": \\"\\",\\n \\"HttpApiIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx\\",\\n \\"HttpApiInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx\\",\\n \\"AuthToken\\": \\"GciOiJIUzI1NiJ9***\\",\\n \\"AccessType\\": \\"readWrite\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"StorageDuration\\": 90,\\n \\"ArchiveDuration\\": 60,\\n \\"GrafanaInstanceId\\": \\"grafana-rnggfvhlcdl6m71***\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\",\\n \\"ResourceType\\": \\"PROMETHEUS\\",\\n \\"EnableAuthToken\\": \\"true\\",\\n \\"SupportAuthTypes\\": [\\n \\"AuthFree\\"\\n ],\\n \\"EnableAuthFreeRead\\": false,\\n \\"AuthFreeReadPolicy\\": \\"0.0.0.0/0\\",\\n \\"EnableAuthFreeWrite\\": false,\\n \\"AuthFreeWritePolicy\\": \\"0.0.0.0/0\\",\\n \\"Product\\": \\"arms\\",\\n \\"DbInstanceStatus\\": \\"RUNNING\\",\\n \\"Version\\": \\"V1\\",\\n \\"PaymentTypeUpdateTime\\": \\"2025-02-26T06:05:01Z\\",\\n \\"ExtraInfo\\": {\\n \\"key\\": \\"extraKey\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"tagValue1\\"\\n }\\n ],\\n \\"OpenTelemetryIntraUrl\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetPrometheusIntegration' => [ + 'summary' => 'Queries the information about an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance. Valid values: aliyun-cs and ecs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'Integration', + 'name' => 'IntegrationType', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'asm', - ], + 'schema' => ['title' => '', 'description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", 'type' => 'string', 'required' => true, 'example' => 'tidb'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the exporter.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '28**', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.'."\n", 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9BEF2832-9D95-5E3E-9B10-74887C******'], 'Data' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The prompt information of the returned result.', - 'type' => 'string', - 'example' => 'success', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['title' => '', 'description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], + 'InstanceId' => ['description' => 'The ID of the exporter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '28**', 'title' => ''], + 'ShowDescribe' => ['description' => 'Indicates whether the description is displayed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NeedUpgrade' => ['description' => 'Indicates whether an upgrade is required.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the exporter.'."\n", 'type' => 'string', 'example' => 'lpd-skyeye', 'title' => ''], + 'IntegrationType' => ['title' => '', 'description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", 'type' => 'string', 'example' => 'tidb'], + 'ExporterType' => ['title' => '', 'description' => 'The type of the exporter.'."\n", 'type' => 'string', 'example' => 'tidb-exporter'], + 'Version' => ['description' => 'The version information.'."\n", 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'Target' => ['description' => 'The monitored IP address.'."\n", 'type' => 'string', 'example' => '127.0.XX.XX:3422', 'title' => ''], + 'CanDelete' => ['description' => 'Indicates whether the exporter can be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CanEditor' => ['description' => 'Indicates whether the exporter can be modified.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Status' => ['description' => 'The status of the exporter.'."\n", 'type' => 'string', 'example' => 'installed', 'title' => ''], + 'Describe' => ['description' => 'The description of the exporter.'."\n", 'type' => 'string', 'example' => '"{}"', 'title' => ''], + 'ShowLog' => ['description' => 'Indicates whether the exporter logs are displayed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'ContainerName' => ['description' => 'The container name.'."\n", 'type' => 'string', 'example' => 'kafka-exporter-1', 'title' => ''], + 'Param' => ['title' => '', 'description' => 'The parameters of the exporter. Format: JSON string.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "port": "5554",'."\n" + .' "name": "kafka-test12",'."\n" + .' "kafka_instance": "kafka-test",'."\n" + .' "__label_value": "kafka-test",'."\n" + .' "scrape_interval": 33,'."\n" + .' "metrics_path": "/metrics",'."\n" + .' "__label_key": "kafka-test"'."\n" + .'}'], + ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::InstallAddon', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<AddIntegrationResponse>\\n\\t<RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n\\t<Data>success</Data>\\n</AddIntegrationResponse>","errorExample":""}]', - 'title' => 'AddIntegration', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'GetIntegrationState' => [ - 'summary' => 'Queries the integration state of the dashboards and collection rules of Application Real-Time Monitoring Service (ARMS) Prometheus.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'GetPrometheusIntegration', + 'changeSet' => [ + ['createdAt' => '2023-04-10T08:18:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-23T06:55:53.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusIntegration'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BEF2832-9D95-5E3E-9B10-74887C******\\",\\n \\"Data\\": {\\n \\"ClusterId\\": \\"cc7a37ee31aea4ed1a059eff8034b****\\",\\n \\"InstanceId\\": 0,\\n \\"ShowDescribe\\": true,\\n \\"NeedUpgrade\\": true,\\n \\"InstanceName\\": \\"lpd-skyeye\\",\\n \\"IntegrationType\\": \\"tidb\\",\\n \\"ExporterType\\": \\"tidb-exporter\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"Target\\": \\"127.0.XX.XX:3422\\",\\n \\"CanDelete\\": true,\\n \\"CanEditor\\": true,\\n \\"Status\\": \\"installed\\",\\n \\"Describe\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"ShowLog\\": \\"true\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"ContainerName\\": \\"kafka-exporter-1\\",\\n \\"Param\\": \\"{\\\\n \\\\\\"port\\\\\\": \\\\\\"5554\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"kafka-test12\\\\\\",\\\\n \\\\\\"kafka_instance\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"__label_value\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"scrape_interval\\\\\\": 33,\\\\n \\\\\\"metrics_path\\\\\\": \\\\\\"/metrics\\\\\\",\\\\n \\\\\\"__label_key\\\\\\": \\\\\\"kafka-test\\\\\\"\\\\n}\\"\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'GetPrometheusMonitoring' => [ + 'summary' => 'Queries the monitoring configuration of a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The type of the monitoring configuration. '."\n" + .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe. '."\n" + .'Valid values for a Prometheus instance for ECS: customJob and probe.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob'], ], [ - 'name' => 'Integration', + 'name' => 'MonitoringName', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the software that is supported by ARMS. Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'asm', - ], + 'schema' => ['title' => '', 'description' => 'The name of the monitoring configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob1'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Response schema.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'State' => [ - 'description' => 'The integration state of Prometheus dashboards and collection rules. Valid values:'."\n" - ."\n" - .'* `true`: The Prometheus dashboards and collection rules that monitor the software are integrated.'."\n" - .'* `false`: The Prometheus dashboards and collection rules that monitor the software are not integrated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The prompt information of the returned result.', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', 'title' => ''], + 'MonitoringName' => ['description' => 'The name of the monitoring configuration.'."\n", 'type' => 'string', 'example' => 'customJob1', 'title' => ''], + 'Type' => ['title' => 'serviceMonitor、podMonitor、customJob、probe', 'description' => 'The type of the monitoring configuration. Valid values: serviceMonitor, podMonitor, customJob, and probe.', 'type' => 'string', 'example' => 'serviceMonitor'], + 'Status' => ['title' => 'run, stop', 'description' => 'The status of the monitoring configuration. Valid values: run and stop.'."\n", 'type' => 'string', 'example' => 'run'], + 'ConfigYaml' => ['description' => 'The monitoring configuration. The value is a YAML string.'."\n", 'type' => 'string', 'example' => '参见返回参数补充说明。', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::DescribeAddonRelease', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'GetPrometheusMonitoring', + 'responseParamsDescription' => 'ServiceMonitor example:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: ServiceMonitor'."\n" + .' metadata:'."\n" + .' name: tomcat-demo'."\n" + .' namespace: default'."\n" + .' spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' path: /metrics'."\n" + .' port: tomcat-monitor'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: tomcat'."\n" + ."\n" + .'PodMonitor example:'."\n" + ."\n" + .' apiVersion: "monitoring.coreos.com/v1"'."\n" + .' kind: "PodMonitor"'."\n" + .' metadata:'."\n" + .' name: "podmonitor-demo"'."\n" + .' namespace: "default"'."\n" + .' spec:'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: "30s"'."\n" + .' path: "/metrics"'."\n" + .' port: "tomcat-monitor"'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: "nginx2-exporter"'."\n" + ."\n" + .'CustomJob example:'."\n" + ."\n" + .' scrape_configs:'."\n" + .' - job_name: prometheus1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + ."\n" + .'Probe example:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: Probe'."\n" + .' metadata:'."\n" + .' name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox'."\n" + .' namespace: arms-prom # Optional.'."\n" + .' spec:'."\n" + .' interval: 30s'."\n" + .' jobName: blackbox'."\n" + .' module: tcp_connect'."\n" + .' prober:'."\n" + .' path: /blackbox/probe'."\n" + .' scheme: http'."\n" + .' url: \'localhost:9335\''."\n" + .' targets:'."\n" + .' staticConfig:'."\n" + .' static:'."\n" + .' - \'arms-prom-admin.arms-prom:9335\''."\n", + 'changeSet' => [ + ['createdAt' => '2023-05-25T02:06:32.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusMonitoring'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"State\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<GetIntegrationStateResponse>\\n <RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n <State>true</State>\\n</GetIntegrationStateResponse>","errorExample":""}]', - 'title' => 'GetIntegrationState', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"ClusterId\\": \\"c589a1b8db05c4561aefbb898ca8fb1cf\\",\\n \\"MonitoringName\\": \\"customJob1\\",\\n \\"Type\\": \\"serviceMonitor\\",\\n \\"Status\\": \\"run\\",\\n \\"ConfigYaml\\": \\"参见返回参数补充说明。\\"\\n },\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'DeleteIntegration' => [ - 'summary' => 'Deletes the collection rules for a Container Service for Kubernetes (ACK) cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRecordingRule' => [ + 'summary' => 'Obtains the recording rule of a cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACK cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'Integration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'asm', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Data' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****'], + 'Data' => ['description' => 'The recording rule.', 'type' => 'string', 'example' => '--- groups: - name: "recording_demo" rules: - expr: "sum(jvm_memory_max_bytes)" record: "rate_coredns_demo"', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates a successful request, whereas others indicate a failed request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::DeleteAddonRelease', + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'title' => 'GetRecordingRule', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-19T06:33:41.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecordingRule'], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteIntegrationResponse>\\n <RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n <Data>success</Data>\\n</DeleteIntegrationResponse>","errorExample":""}]', - 'title' => 'DeleteIntegration', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"Data\\": \\"--- groups: - name: \\\\\\"recording_demo\\\\\\" rules: - expr: \\\\\\"sum(jvm_memory_max_bytes)\\\\\\" record: \\\\\\"rate_coredns_demo\\\\\\"\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'AddGrafana' => [ - 'summary' => 'Integrates the dashboard of Managed Service for Prometheus.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRetcodeAppByPid' => [ + 'summary' => 'Queries the objects of a Browser Monitoring application by process identifier (PID).', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The PID of the application. To obtain the PID of the application, perform the following steps: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of the application. The URL in the address bar contains the PID of the application. The PID is in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with the at sign (@) to obtain xxx@74xxx.'."\n", 'type' => 'string', 'required' => true, 'example' => 'b590lhguqs@9781be0f44dXXXX', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Integration', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The abbreviation of the software that is supported by Application Real-Time Monitoring Service (ARMS). Valid values (case-insensitive): `ASM`, `IoT`, and `Flink`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'asm', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'required' => false, 'description' => 'The tag key.'."\n", 'example' => 'TestKey', 'title' => ''], + 'Value' => ['type' => 'string', 'required' => false, 'description' => 'The tag value.'."\n", 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'description' => 'The list of tags.'."\n", + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****'], + 'RetcodeApp' => [ + 'description' => 'The returned application data.'."\n", + 'type' => 'object', + 'properties' => [ + 'AppName' => ['description' => 'The name of the application that is monitored by Browser Monitoring.'."\n", 'type' => 'string', 'example' => 'testRetcodeAppXXXX', 'title' => ''], + 'RetcodeAppType' => ['description' => 'The type of the application that is monitored by Browser Monitoring. Valid values:'."\n" + ."\n" + .'* `web`: web application'."\n" + .'* `weex`: Weex mobile app'."\n" + .'* `mini_dd`: DingTalk mini program'."\n" + .'* `mini_alipay`: Alipay mini program'."\n" + .'* `mini_wx`: WeChat mini program'."\n" + .'* `mini_common`: mini program on other platforms'."\n", 'type' => 'string', 'example' => 'web', 'title' => ''], + 'AppId' => ['description' => 'The ID of the application. The parameter is an auto-increment parameter.'."\n", 'type' => 'string', 'example' => '2787XXXX', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'b590lhguqs@9781be0f44dXXXX', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", 'type' => 'string', 'example' => 'rg-acfmxidtzXXXX', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags that are attached to the instance.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'testKey', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'testValue', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\"\\n}","errorExample":""},{"type":"xml","example":"<AddGrafanaResponse>\\n\\t<RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n\\t<Data>success</Data>\\n</AddGrafanaResponse>","errorExample":""}]', - 'title' => 'AddGrafana', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'InstallCmsExporter' => [ - 'summary' => 'Installs the cms-exporter collector.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"RetcodeApp\\": {\\n \\"AppName\\": \\"testRetcodeAppXXXX\\",\\n \\"RetcodeAppType\\": \\"web\\",\\n \\"AppId\\": \\"2787XXXX\\",\\n \\"Pid\\": \\"b590lhguqs@9781be0f44dXXXX\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxidtzXXXX\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"testKey\\",\\n \\"Value\\": \\"testValue\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetRetcodeAppByPid', + 'changeSet' => [ + ['createdAt' => '2024-06-19T01:54:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-28T03:17:51.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRetcodeAppByPid'], + ], ], + 'ramActions' => [], + ], + 'GetRetcodeDataByQuery' => [ + 'summary' => 'Queries the Browser Monitoring data based on a query statement of Log Service.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The ID of the application.'."\n" + ."\n" + .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.'."\n", 'type' => 'string', 'required' => true, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Query', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The query statement that conforms to the query syntax of a Log Service Logstore.'."\n", 'type' => 'string', 'required' => true, 'example' => 't : pv|select sum(times) as pv , approx_distinct(uid) as uv , (date-date%3600000) as date group by date', 'title' => ''], ], [ - 'name' => 'CmsArgs', + 'name' => 'From', 'in' => 'query', - 'schema' => [ - 'title' => '云监控接入方式支持的参数，多个产品名用#分隔', - 'description' => 'The cloud services that you want to monitor. The CmsArgs parameter is the startup parameter of the cms-exporter collector. Separate multiple cloud services with number signs (`#`).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'hologres#cen', - ], + 'schema' => ['description' => 'The beginning of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1668687302', 'title' => ''], ], [ - 'name' => 'EnableTag', + 'name' => 'To', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to collect the aliyun tags attached to each cloud service. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'false', - 'default' => 'true', - ], + 'schema' => ['description' => 'The end of the time range to query. This value is a UNIX timestamp representing the number of seconds that have elapsed since the epoch time January 1, 1970, 00:00:00 UTC.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1668688000', 'title' => ''], ], [ - 'name' => 'DirectArgs', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '一方接入方式支持的参数，多个产品名用#分隔', - 'description' => 'The recently monitored cloud services. Separate multiple cloud services with number signs (`#`).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'hologres#cen', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'The struct returned.'."\n", + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1', - ], - 'Data' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* 2XX: The request was successful.'."\n" + .'* 3XX: A redirection message was returned.'."\n" + .'* 4XX: The request was invalid.'."\n" + .'* 5XX: A server error occurred.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the call fails.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The Browser Monitoring data returned.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "total": 1,'."\n" + .' "auth": false,'."\n" + .' "pageSize": 20,'."\n" + .' "completed": true,'."\n" + .' "page": 1,'."\n" + .' "items": ['."\n" + .' {'."\n" + .' "date": "1701820800000",'."\n" + .' "__time__": 1701410567,'."\n" + .' "uv": "64",'."\n" + .' "__source__": "",'."\n" + .' "pv": "890"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::InstallAddon', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"-\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"{\\\\n \\\\\\"total\\\\\\": 1,\\\\n \\\\\\"auth\\\\\\": false,\\\\n \\\\\\"pageSize\\\\\\": 20,\\\\n \\\\\\"completed\\\\\\": true,\\\\n \\\\\\"page\\\\\\": 1,\\\\n \\\\\\"items\\\\\\": [\\\\n {\\\\n \\\\\\"date\\\\\\": \\\\\\"1701820800000\\\\\\",\\\\n \\\\\\"__time__\\\\\\": 1701410567,\\\\n \\\\\\"uv\\\\\\": \\\\\\"64\\\\\\",\\\\n \\\\\\"__source__\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"pv\\\\\\": \\\\\\"890\\\\\\"\\\\n }\\\\n ]\\\\n\\\\t}\\"\\n}","type":"json"}]', + 'title' => 'GetRetcodeDataByQuery', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRetcodeDataByQuery'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'InstallCmsExporter', + 'ramActions' => [], ], - 'OpenVCluster' => [ - 'summary' => 'Activates a virtual cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetRetcodeLogstore' => [ + 'summary' => 'Queries the Log Service project and Logstore that correspond to an application of browser monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the cluster. For cloud services, set this parameter to `cloud-product-prometheus`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cloud-product-prometheus', - ], - ], - [ - 'name' => 'Length', - 'in' => 'query', - 'schema' => [ - 'description' => 'The length of the cluster ID. Default value: 10.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - [ - 'name' => 'Product', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the cloud service. This parameter must be specified when ClusterType is set to `cloud-product-prometheus`. Valid values: influxdb, mongodb, and DLA. You cannot specify multiple service names.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'influxdb', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application. To obtain the PID of the application, perform the following steps: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of the application. The URL in the address bar contains the PID of the application. The PID is in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with the at sign (@) to obtain xxx@74xxx.'."\n", 'type' => 'string', 'required' => true, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'RecreateSwitch', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned struct.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], 'Data' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'rre59xelcx', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '42E58E4D-ACAD-4400-8FAF-F762340AE5B3', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the request.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The content of the log.'."\n", 'type' => 'string', 'example' => 'retcode app or task can not be found!', 'title' => ''], + 'RetcodeSLSConfig' => [ + 'description' => 'The information about Log Service.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Project' => ['description' => 'The Log Service project.'."\n", 'type' => 'string', 'example' => 'test-project', 'title' => ''], + 'Logstore' => ['description' => 'The Log Service Logstore.'."\n", 'type' => 'string', 'example' => 'log-test-220431', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"rre59xelcx\\",\\n \\"RequestId\\": \\"42E58E4D-ACAD-4400-8FAF-F762340AE5B3\\"\\n}","type":"json"}]', - 'title' => 'OpenVCluster', - ], - 'DeletePrometheusGlobalView' => [ - 'summary' => 'Deletes a global aggregation instance from Prometheus Service.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": {\\n \\"Status\\": \\"true\\",\\n \\"Message\\": \\"retcode app or task can not be found!\\",\\n \\"RetcodeSLSConfig\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Project\\": \\"test-project\\",\\n \\"Logstore\\": \\"log-test-220431\\"\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetRetcodeLogstore', + 'changeSet' => [ + ['createdAt' => '2022-11-15T08:32:01.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRetcodeLogstore'], + ], ], + 'ramActions' => [], + ], + 'GetRetcodeShareUrl' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GlobalViewClusterId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'global-v2-cn-1670100631025794-amaykca4', - ], + 'schema' => ['description' => 'The project ID (PID) of the application.'."\n" + ."\n" + .'To obtain the application PID, log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Browser Monitoring**>**Browser Monitoring**. Then, click the name of the application. The URL in the address bar contains the application PID, in the xxx format. As the browser is encoded, you must modify the PID. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with an at sign (@) to obtain xxx@74xxx.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'iioe7jcnuk@582846f37******', 'title' => ''], ], ], 'responses' => [ @@ -19853,653 +14548,820 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The response parameters in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{"Success":true,"Msg":"OK"}', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates a successful request, whereas others indicate a failed request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The supplemental message providing additional context about the response.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'Url' => ['description' => 'The share URL of the application monitored by Browser Monitoring.'."\n", 'type' => 'string', 'example' => 'http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{\\\\\\"Success\\\\\\":true,\\\\\\"Msg\\\\\\":\\\\\\"OK\\\\\\"}\\",\\n \\"RequestId\\": \\"337B8F7E-0A64-5768-9225-E9B3CF******\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePrometheusGlobalViewResponse>\\n <Data>{\\"Success\\":true,\\"Msg\\":\\"OK\\"}</Data>\\n <RequestId>337B8F7E-0A64-5768-9225-E9B3CF******</RequestId>\\n</DeletePrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'DeletePrometheusGlobalView', - ], - 'RemoveAliClusterIdsFromPrometheusGlobalView' => [ - 'summary' => 'Removes data sources from a global aggregation instance in Managed Service for Prometheus.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Url\\": \\"http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1\\",\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\"\\n}","errorExample":""},{"type":"xml","example":"<GetRetcodeShareUrlResponse>\\n <requestId>01FF8DD9-A09C-47A1-895A-B6E321BE77B6</requestId>\\n <url>http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1</url>\\n</GetRetcodeShareUrlResponse>","errorExample":""}]', + 'title' => 'GetRetcodeShareUrl', + 'summary' => 'Queries the share URL of an application monitored by Browser Monitoring.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-15T07:03:52.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetRumAppInfo' => [ + 'summary' => 'Retrieves a single Frontend Monitoring application.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '197299', + 'abilityTreeNodes' => ['FEATUREarmsRY7LT8'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'AppGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zyGlobalView', - ], + 'schema' => ['description' => 'The application group.', 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'GlobalViewClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'global-v2-cn-1670100631025794-amaykca4', - ], - ], - [ - 'name' => 'ClusterIds', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of clusters. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'type' => 'object', - 'properties' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'Code' => ['description' => 'The HTTP status code. A `200` status code indicates a successful request.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + ."\n" + .'- `false`: The request failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned for a failed request.', 'type' => 'string', 'example' => '内部错误，请联系管理员。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The details of the application.', 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'CreateTime' => ['description' => 'The creation time of the application. This value is a UNIX timestamp in milliseconds.', 'type' => 'string', 'example' => '1683353594000', 'title' => ''], + 'Name' => ['description' => 'The application name.', 'type' => 'string', 'example' => 'tomcat-demo-test', 'title' => ''], + 'Pid' => ['description' => 'The application ID.', 'type' => 'string', 'example' => 'avccccefy0@24cccccbf384dc6', 'title' => ''], + 'Type' => ['description' => 'The application type. This parameter is a constant of `RUM`.', 'type' => 'string', 'example' => 'RUM', 'title' => ''], + 'NickName' => ['description' => 'The alias of the application.', 'type' => 'string', 'example' => 'nickname', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AppType' => ['description' => 'The application type. Valid values: `web`, `miniapp`, `ios`, and `android`. `web` indicates Web and H5 applications, `miniapp` indicates mini programs.', 'type' => 'string', 'example' => 'web', 'title' => ''], + 'Status' => ['description' => 'The application status. Valid values: `created`, `running`, and `stopped`. `stopped` indicates that data reporting is stopped.', 'type' => 'string', 'example' => 'running', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-aek2vezare****', 'title' => ''], + 'IsSubscription' => ['description' => 'Indicates whether the application is bookmarked. Valid values: `true` and `false`.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The description of the application.', 'type' => 'string', 'example' => '门户首页。', 'title' => ''], + 'PackageName' => ['description' => 'The application package name.', 'type' => 'string', 'example' => 'com.alibaba.rum', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint for reporting application data.', 'type' => 'string', 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', 'title' => ''], + 'SlsProject' => ['description' => 'The name of the Log Service project that is used to store application data.', 'type' => 'string', 'example' => 'proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'example' => 'Label', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'Value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Msg' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => 'OK', + 'SlsLogstore' => ['description' => 'The name of the Log Service Logstore that is used to store application data.', 'type' => 'string', 'example' => 'logstore-rum', 'title' => ''], + 'ServiceDomainConfigs' => [ + 'description' => 'The list of service domain name configurations. This parameter is supported only for mobile applications.', + 'type' => 'array', + 'items' => [ + 'description' => 'The service domain name configuration.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name or IP address.', 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Description' => ['description' => 'The description.', 'type' => 'string', 'example' => '测试', 'title' => ''], + 'Tracing' => ['description' => 'Indicates whether to enable trace tracking. You must activate Application Real-Time Monitoring Service (ARMS) OpenTelemetry Edition to use this feature. Valid values:'."\n" + ."\n" + .'- `true`: enables trace tracking. If you set this parameter to true, a related header is inserted into the request for this domain name.'."\n" + ."\n" + .'- `false`: does not enable trace tracking.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'PropagatorTypes' => [ + 'description' => 'The list of trace pass-through protocols. This parameter is required when trace tracking is enabled.', + 'type' => 'array', + 'items' => ['description' => 'The trace pass-through protocol. Only Skywalking V2 and V3 are supported, which correspond to `sw6` and `sw8`.', 'type' => 'string', 'example' => 'sw8', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'SamplingRate' => ['description' => 'The trace sampling rate. Valid values: (0, 100].', 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Info' => [ - 'description' => 'The Info-level information.'."\n", - 'type' => 'string', - 'example' => '{regionId: the region where the global aggregation instance resides. globalViewClusterId: the ID of the global aggregation instance. failedClusterIds: the IDs of the clusters that failed to be added. A cluster may fail to be added if the specified cluster ID is invalid.}'."\n", + 'CdnDomain' => ['description' => 'The SDK domain name.', 'type' => 'string', 'example' => 'b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js', 'title' => ''], + 'BonreeSDKConfig' => [ + 'description' => 'The data collection configurations for mobile applications.', + 'type' => 'object', + 'properties' => [ + 'moduleConfig' => [ + 'description' => 'The feature switches for modules.', + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'The master switch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'defaultConfig' => [ + 'description' => 'The default configuration of the application.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'The switch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The configuration items of the module.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'versionConfigs' => [ + 'description' => 'The application version configurations.', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'useCustom' => ['description' => 'Indicates whether to use a custom configuration.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'customConfig' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'enable' => ['description' => 'The switch.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => 'The configuration items of the module.', + 'title' => '', + 'example' => '', + ], + 'description' => 'The custom configuration items.', + 'title' => '', + 'example' => '', + ], + 'description' => ['description' => 'The description of the version configuration.', 'type' => 'string', 'example' => '1.1.0版本配置', 'title' => ''], + 'updateTime' => ['description' => 'The update time of the version configuration.', 'type' => 'integer', 'format' => 'int64', 'example' => '1721112372055', 'title' => ''], + ], + 'description' => 'The version configuration.', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'samplingConfig' => [ + 'description' => 'The sampling configuration.', + 'type' => 'object', + 'properties' => [ + 'samplingType' => ['description' => 'The sampling type. Only random session sampling is supported. You must set this parameter to `1`.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'samplingRate' => ['description' => 'The sampling rate, in parts per thousand. The value must be greater than 0 and less than or equal to 1,000.', 'type' => 'integer', 'format' => 'int32', 'example' => '500', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'AppGroup' => ['description' => 'The application group.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'BackendServiceTraceRegion' => ['description' => 'The region where the back-end application is deployed. This parameter is used for end-to-end tracing.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AppConfig' => ['description' => 'This parameter is deprecated. The legacy application configuration in the JSON format.', 'type' => 'string', 'example' => '{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}', 'title' => ''], + 'WebSDKConfigJson' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'GetRumAppInfo', + 'description' => 'User experience monitoring is available only in China (Hangzhou), Asia Pacific SE 1 (Singapore), and US West 1 (Silicon Valley). Select the correct endpoint.', + 'changeSet' => [ + ['createdAt' => '2025-09-16T15:18:07.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-05-06T08:54:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T02:00:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2025-01-07T03:50:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-29T03:16:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-09-19T11:25:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-08-16T07:53:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-08T17:09:09.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-10T03:54:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-03T08:00:38.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-28T08:54:26.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误）}\\"\\n },\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<RemoveAliClusterIdsFromPrometheusGlobalViewResponse>\\n <Data>\\n <Success>true</Success>\\n <Msg>OK</Msg>\\n <Info>{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误）}</Info>\\n </Data>\\n <RequestId>F7781D4A-2818-41E7-B7BB-79D809E9****</RequestId>\\n</RemoveAliClusterIdsFromPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'RemoveAliClusterIdsFromPrometheusGlobalView', - ], - 'RemoveSourcesFromPrometheusGlobalView' => [ - 'summary' => 'Removes data sources from a global aggregation instance in Managed Service for Prometheus. You can delete only data sources that are not from Alibaba Cloud.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumAppInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"CreateTime\\": \\"1683353594000\\",\\n \\"Name\\": \\"tomcat-demo-test\\",\\n \\"Pid\\": \\"avccccefy0@24cccccbf384dc6\\",\\n \\"Type\\": \\"RUM\\",\\n \\"NickName\\": \\"nickname\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppType\\": \\"web\\",\\n \\"Status\\": \\"running\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\",\\n \\"IsSubscription\\": \\"true\\",\\n \\"Description\\": \\"门户首页。\\",\\n \\"PackageName\\": \\"com.alibaba.rum\\",\\n \\"Endpoint\\": \\"xxxxxxxx-default-cn.rum.aliyuncs.com\\",\\n \\"SlsProject\\": \\"proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"Label\\",\\n \\"Value\\": \\"Value\\"\\n }\\n ],\\n \\"SlsLogstore\\": \\"logstore-rum\\",\\n \\"ServiceDomainConfigs\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"Description\\": \\"测试\\",\\n \\"Tracing\\": true,\\n \\"PropagatorTypes\\": [\\n \\"sw8\\"\\n ],\\n \\"SamplingRate\\": 100\\n }\\n ],\\n \\"CdnDomain\\": \\"b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js\\",\\n \\"BonreeSDKConfig\\": {\\n \\"moduleConfig\\": {\\n \\"enable\\": true,\\n \\"defaultConfig\\": {\\n \\"key\\": {\\n \\"enable\\": true\\n }\\n },\\n \\"versionConfigs\\": {\\n \\"key\\": {\\n \\"useCustom\\": true,\\n \\"customConfig\\": {\\n \\"key\\": {\\n \\"enable\\": true\\n }\\n },\\n \\"description\\": \\"1.1.0版本配置\\",\\n \\"updateTime\\": 1721112372055\\n }\\n }\\n },\\n \\"samplingConfig\\": {\\n \\"samplingType\\": 1,\\n \\"samplingRate\\": 500\\n }\\n },\\n \\"AppGroup\\": \\"default\\",\\n \\"BackendServiceTraceRegion\\": \\"cn-hangzhou\\",\\n \\"AppConfig\\": \\"{\\\\\\"apiRequestOfH5\\\\\\":300,\\\\\\"apiRequestOfOriginal\\\\\\":500,\\\\\\"coldStart\\\\\\":5000,\\\\\\"hotStart\\\\\\":3000,\\\\\\"staticResourceLoad\\\\\\":300,\\\\\\"stutter\\\\\\":1000,\\\\\\"viewLoadOfH5\\\\\\":1000,\\\\\\"viewLoadOfOriginal\\\\\\":2000}\\",\\n \\"WebSDKConfigJson\\": \\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetRumApps' => [ + 'summary' => 'Queries a list of Real User Monitoring (RUM) applications.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '194710', + 'abilityTreeNodes' => ['FEATUREarmsRY7LT8'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AppId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b590lhguqs@28f515462******', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'AppGroup', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'zyGlobalView', - ], + 'schema' => ['description' => 'The group to which the application belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], [ - 'name' => 'GlobalViewClusterId', + 'name' => 'AppName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', - ], + 'schema' => ['description' => 'The name of the application. You can specify only one application name in each request.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'SourceNames', + 'name' => 'AppType', + 'in' => 'query', + 'schema' => ['description' => 'The application type. Currently, supported application types include: web, mini program, Android, iOS, Windows, macOS, and HarmonyOS.'."\n", 'type' => 'string', 'required' => false, 'example' => 'web', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The list of custom data sources. You can specify multiple data sources and separate them with commas (,).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'localPrometheusClusterName,testCumterPrometheusName', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Msg' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'string', - 'example' => 'OK', - ], - 'Info' => [ - 'description' => 'The Info-level information.'."\n", - 'type' => 'string', - 'example' => '{regionId: the region where the aggregation instance resides. globalViewClusterId: the ID of the aggregation instance.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '70675725-8F11-4817-8106-CFE0AD71****'], + 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => '内部错误，请联系客服。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'AppList' => [ + 'description' => 'The queried applications.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The application details.'."\n", + 'type' => 'object', + 'properties' => [ + 'CreateTime' => ['description' => 'The time when the application was created. The value is a timestamp.'."\n", 'type' => 'any', 'example' => '1685686960872', 'title' => ''], + 'Name' => ['description' => 'The application name.'."\n", 'type' => 'string', 'example' => '门户首页。', 'title' => ''], + 'Pid' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'example' => 'xxxxx@cc08bdxxxx20b15', 'title' => ''], + 'Type' => ['description' => 'The type of the application. Valid value: RUM.'."\n", 'type' => 'string', 'example' => 'RUM', 'title' => ''], + 'NickName' => ['description' => 'The alias of the application.'."\n", 'type' => 'string', 'example' => 'Williamtag', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AppType' => ['description' => 'The application type. Valid values: web, miniapp, ios, and android.'."\n", 'type' => 'string', 'example' => 'web', 'title' => ''], + 'Status' => ['description' => 'The status of the application. Valid values: created, running, and stopped.'."\n", 'type' => 'string', 'example' => 'running', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmzaq3ypaqkdy', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. The tag key can be up to 128 characters in length. It cannot start with aliyun or acs: and cannot contain http:// or https://.'."\n", 'type' => 'string', 'example' => 'tag1', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'ok', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'IsSubscription' => ['description' => 'Indicates whether the application is subscribed. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Description' => ['description' => 'The description of the application.'."\n", 'type' => 'string', 'example' => '测试', 'title' => ''], + 'PackageName' => ['description' => 'The package name of the Android application.'."\n", 'type' => 'string', 'example' => 'com.zy.yxws', 'title' => ''], + 'Endpoint' => ['description' => 'The endpoint that is used to report application data.'."\n", 'type' => 'string', 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', 'title' => ''], + 'SlsProject' => ['description' => 'The name of the Simple Log Service project that stores application data.'."\n", 'type' => 'string', 'example' => 'proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou', 'title' => ''], + 'SlsLogstore' => ['description' => 'The name of the Simple Log Service Logstore that stores application data.'."\n", 'type' => 'string', 'example' => 'logstore-rum', 'title' => ''], + 'ServiceDomainConfigs' => [ + 'description' => 'The list of service domain configurations. Only mobile applications are supported.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The service domain configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name or IP address.'."\n", 'type' => 'string', 'example' => 'example.com', 'title' => ''], + 'Description' => ['description' => 'The description.'."\n", 'type' => 'string', 'example' => '测试', 'title' => ''], + 'Tracing' => ['description' => 'Indicates whether the tracing analysis feature is enabled. To enable the tracing analysis feature, you must activate Managed Service for OpenTelemetry. Valid values:'."\n" + ."\n" + .'* `true`: enables the tracing analysis feature. If you enable the tracing analysis feature, related headers are inserted into requests for the domain name.'."\n" + .'* `false`: disables the tracing analysis feature.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'PropagatorTypes' => [ + 'description' => 'The trace propagation protocols. This parameter is required if the tracing analysis feature is enabled.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The trace propagation protocol. Valid values: sw6 and sw8. sw6 indicates SkyWalking V2 and sw8 indicates SkyWalking V3.'."\n", 'type' => 'string', 'example' => 'sw8', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id}\\"\\n },\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<RemoveSourcesFromPrometheusGlobalViewResponse>\\n <Data>\\n <Success>true</Success>\\n <Msg>OK</Msg>\\n <Info>{regionId: 实例所属region, globalViewClusterId: 实例Id}</Info>\\n </Data>\\n <RequestId>9319A57D-2D9E-472A-B69B-CF3CD16D****</RequestId>\\n</RemoveSourcesFromPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'RemoveSourcesFromPrometheusGlobalView', - ], - 'DeleteCmsExporter' => [ - 'summary' => 'Uninstalls a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"内部错误，请联系客服。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"AppList\\": [\\n {\\n \\"CreateTime\\": \\"1685686960872\\",\\n \\"Name\\": \\"门户首页。\\",\\n \\"Pid\\": \\"xxxxx@cc08bdxxxx20b15\\",\\n \\"Type\\": \\"RUM\\",\\n \\"NickName\\": \\"Williamtag\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AppType\\": \\"web\\",\\n \\"Status\\": \\"running\\",\\n \\"ResourceGroupId\\": \\"rg-acfmzaq3ypaqkdy\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"tag1\\",\\n \\"Value\\": \\"ok\\"\\n }\\n ],\\n \\"IsSubscription\\": true,\\n \\"Description\\": \\"测试\\",\\n \\"PackageName\\": \\"com.zy.yxws\\",\\n \\"Endpoint\\": \\"xxxxxxxx-default-cn.rum.aliyuncs.com\\",\\n \\"SlsProject\\": \\"proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou\\",\\n \\"SlsLogstore\\": \\"logstore-rum\\",\\n \\"ServiceDomainConfigs\\": [\\n {\\n \\"Domain\\": \\"example.com\\",\\n \\"Description\\": \\"测试\\",\\n \\"Tracing\\": \\"true\\",\\n \\"PropagatorTypes\\": [\\n \\"sw8\\"\\n ]\\n }\\n ]\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetRumApps', + 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-06T08:54:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-13T05:41:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-07T03:50:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-12T06:05:50.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetRumDataForPage' => [ + 'summary' => 'Queries Real User Monitoring (RUM) data by page.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197708', + 'abilityTreeNodes' => ['FEATUREarmsH2Y9JL'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Query', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'A query statement that complies with the query syntax of Simple Log Service Logstore. For more information, see the parameters corresponding to this operation on the console page.'."\n", 'type' => 'string', 'required' => true, 'example' => '* and app.id: xxxx@586810fbxxxx19f '."\n", 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'iixxxjcnuk@582846f37******', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - 'Data' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'success', - ], - ], - ], + [ + 'name' => 'AppGroup', + 'in' => 'query', + 'schema' => ['description' => 'The group to which the application belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'default', 'title' => ''], ], - ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::DeleteAddonRelease', + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The time is accurate to seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1713687833', 'title' => ''], ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'DeleteCmsExporter', - ], - 'DelAuthToken' => [ - 'summary' => 'Disables an authentication token.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. The time is accurate to seconds.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1713774233', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['description' => 'The responses code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => '内部错误，请联系管理员。'."\n", 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the call was successful.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', + 'description' => 'The result of the operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'string', 'example' => '7', 'title' => ''], + 'Page' => ['description' => 'The page number.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'string', 'example' => '20', 'title' => ''], + 'Authentication' => ['description' => 'A reserved parameter. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '保留字段，请忽略。', 'title' => ''], + 'Completion' => ['description' => 'Indicates whether the query ends. Valid values: true and false.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Preference' => ['description' => 'A reserved parameter. Ignore this parameter.'."\n", 'type' => 'string', 'example' => '保留字段，请忽略。'."\n" + ."\n", 'title' => ''], + 'Items' => [ + 'description' => 'The queried data.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The details of the queried data, in the JSON Map format.'."\n", 'type' => 'object', 'example' => '查询到的数据详情，JSON Map格式。'."\n" + ."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\"\\n}","type":"json"}]', - 'title' => 'DelAuthToken', - ], - 'DeleteGrafanaResource' => [ - 'summary' => 'Deletes Grafana dashboard resources from a Managed Service for Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"内部错误，请联系管理员。\\\\n\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Total\\": \\"7\\",\\n \\"Page\\": \\"1\\",\\n \\"PageSize\\": \\"20\\",\\n \\"Authentication\\": \\"保留字段，请忽略。\\",\\n \\"Completion\\": \\"true\\",\\n \\"Preference\\": \\"保留字段，请忽略。\\\\n\\\\n\\",\\n \\"Items\\": [\\n {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetRumDataForPage', + 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-05-06T08:54:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-07T03:50:08.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-08-16T07:53:56.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetRumExceptionStack' => [ + 'summary' => 'Retrieves Real User Monitoring (RUM) exception stack information.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '213079', + 'abilityTreeNodes' => ['FEATUREarms46ES94'], ], 'parameters' => [ [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'atxxxxzkcf@d8deedfa9bf****', 'title' => ''], + ], + [ + 'name' => 'ExceptionStack', + 'in' => 'query', + 'schema' => ['description' => 'The error stack information in JSON list format. Each list element contains three fields: call_stack.info, call_stack.thread.name, and call_stack.thread.id, which represent the stack information, thread name, and thread ID, respectively. This is identical to the exception.stack field in the Simple Log Service logstore-rum.', 'type' => 'string', 'required' => false, 'example' => '['."\n" + .'{'."\n" + .' "call_stack.info": "libsystem_kernel.dylib 0x00000001f1ce9178 0x00000001f1ce8000 + 4472\\r\\nlibsystem_kernel.dylib 0x00000001f1ce8f10 0x00000001f1ce8000 + 3856\\r\\nlibsystem_kernel.dylib 0x00000001f1ced718 0x00000001f1ce8000 + 22296\\r\\nAlibabaCloudRUM 0x0000000106711af4 0x0000000106660000 + 727796\\r\\nlibsystem_pthread.dylib 0x00000002146744d4 0x0000000214672000 + 9428",'."\n" + .' "call_stack.thread.name": "#3 BRSCrash Exception Handler (Secondary)",'."\n" + .' "call_stack.thread.id": "16643"'."\n" + .' }'."\n" + .']', 'title' => ''], + ], + [ + 'name' => 'ExceptionBinaryImages', + 'in' => 'query', + 'schema' => ['description' => 'The binary images, which represent all executable files loaded into the process address space at the time of the crash.', 'type' => 'string', 'required' => false, 'example' => 'iOSDemo:arm64%3B1489F4D3-6DE2-300C-90E9-E1B869675351%3B0x0000000104064000\\nAlibabaCloudRUM:arm64%3BAB7B3A8E-6CEE-325D-BCBB-8DA50E61804F%3B0x0000000106660000\\nlibdispatch.dylib:arm', 'title' => ''], + ], + [ + 'name' => 'ExceptionThreadId', + 'in' => 'query', + 'schema' => ['description' => 'The exception thread ID.', 'type' => 'string', 'required' => false, 'example' => '16643', 'title' => ''], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'clusterNameOfTest', - ], + 'name' => 'SourcemapType', + 'in' => 'query', + 'schema' => ['description' => 'The parsing type. Valid values:'."\n" + .'- js: JavaScript error parsing'."\n" + .'- sym: PC parsing'."\n" + .'- har: HarmonyOS parsing'."\n" + .'- dSYM: iOS parsing'."\n" + .'- so: Android parsing.', 'type' => 'string', 'required' => false, 'example' => 'js', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'name' => 'ExtraInfo', + 'in' => 'query', + 'schema' => ['description' => 'The additional system symbol table information for iOS parsing. This parameter is optional.', 'type' => 'string', 'required' => false, 'example' => 'GraphicsServices:system/GraphicsServices/85419099-269B-336D-86B4-0D52D0FF6923/GraphicsServices;WebCore:system/WebCore/BF44A3F4-85D4-38C8-BF26-197F06ADE273/WebCore', 'title' => ''], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****'], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`: The request was successful.'."\n" + .'- `false`: The request failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned when the call fails.', 'type' => 'string', 'example' => '内部错误，请联系管理员。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'delete success.', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '771DC66C-C5E0-59BC-A983-DD18FEE9EFFA', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates a successful request, whereas others indicate a failed request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'description' => 'The response data.', + 'type' => 'object', + 'properties' => [ + 'ThreadId' => ['description' => 'The thread ID.', 'type' => 'string', 'example' => '16643', 'title' => ''], + 'Lines' => [ + 'description' => 'The stack list.', + 'type' => 'array', + 'items' => ['description' => 'The parsed error stack information.', 'type' => 'string', 'example' => '"CoreFoundation 0x00000001aa66a678 0x00000001aa57e000 + 968312",'."\n" + .' "libobjc.A.dylib 0x00000001a2917c80 0x00000001a28ec000 + 179328"', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'CrashReason' => ['description' => 'The exception reason. This field is returned only for PC parsing.', 'type' => 'string', 'example' => 'EXC_BAD_ACCESS / KERN_INVALID_ADDRESS', 'title' => ''], + 'CrashAddress' => ['description' => 'The crash address. This field is returned only for PC parsing.', 'type' => 'string', 'example' => '0x1', 'title' => ''], + 'ThreadInfoList' => [ + 'description' => 'The thread stack details captured during a PC crash.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ThreadTag' => ['description' => 'The thread tag, which includes the thread number and thread name.', 'type' => 'string', 'example' => 'Thread 0 (crashed)', 'title' => ''], + 'ThreadDetail' => ['description' => 'The detailed thread stack.', 'type' => 'string', 'example' => ' "0 libsystem_platform.dylib + 0x1ab5\\n rax = 0x0000000000000001 rdx = 0x0000000000000064\\n rcx = 0xffffffffffffffff rbx = 0x0000000107701bd0\\n rsi = 0x0101010101010101 rdi = 0x0000000000000001\\n rbp = 0x00007ff7b8d64300 rsp = 0x00007ff7b8d64300\\n r8 = 0x000000000000000a r9 = 0x0000000000000000\\n r10 = 0x0000000000000001 r11 = 0x0000000000000247\\n r12 = 0x00007ff7b8d64390 r13 = 0x0000000000000000\\n r14 = 0x000000010719d770 r15 = 0x00007ff7b8d64500\\n rip = 0x00007ff807a40ab5\\n Found by: given as instruction pointer in context\\n 1 alibabacloud_rum_example + 0x2ad1\\n rbp = 0x00007ff7b8d64310 rsp = 0x00007ff7b8d64310\\n rip = 0x000000010719dad1\\n Found by: previous frame\'s frame pointer\\n 2 alibabacloud_rum_example + 0x2a3b\\n rbp = 0x00007ff7b8d64360 rsp = 0x00007ff7b8d64320\\n rip = 0x000000010719da3b\\n Found by: previous frame\'s frame pointer\\n 3 0x7ff807688345\\n rbp = 0x00007ff7b8d64580 rsp = 0x00007ff7b8d64370\\n rip = 0x00007ff807688345\\n Found by: previous frame\'s frame pointer"'."\n", 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ModuleName' => ['description' => 'The name of the crash parsing module. This field is returned only for PC parsing.', 'type' => 'string', 'example' => 'alibabacloud_rum_example', 'title' => ''], + 'Uuid' => ['description' => 'The UUID of the symbol table required for stack parsing. This field is returned only for PC parsing.', 'type' => 'string', 'example' => '9032259CEB9130E780C6DE8FDECCD7990', 'title' => ''], + 'BinaryImages' => ['description' => 'The names and UUIDs of the system symbol tables required for exception stack parsing. This field is returned only for PC parsing.', 'type' => 'string', 'example' => '"04B5B216682E40BF9BBE9698E3F98CAA0,libcurl.4.dylib;7878DB3CF21A3C13A203B7E3B0FA66250,libalibabacloud_rum.dylib;0F9F96FE6B1C3253A33AC9E4A0C2A3860,libsystem_kernel.dylib;3DF3256F466E37BCB995A5A9956E14150,libsystem_pthread.dylib;000000000000000000000000000000000,Security;EA4B83A319EB3E15B22CDF035DBD49250,alibabacloud_rum_example;710BB12EEEC744BAB41D1849CA3AD8021,LTSDK.pdb;EE330BA9C49E4730AA15A2B7C0BB2CAE1,JBLive.pdb"', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve RUM exception stack information', + 'description' => 'Real User Monitoring is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.', + 'changeSet' => [ + ['createdAt' => '2025-08-22T06:39:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-20T02:41:25.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-11-27T12:04:20.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-10-17T12:37:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-20T13:54:37.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"delete success.\\",\\n \\"RequestId\\": \\"771DC66C-C5E0-59BC-A983-DD18FEE9EFFA\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteGrafanaResourceResponse>\\n <Data>delete success.</Data>\\n <RequestId>771DC66C-C5E0-59BC-A983-DD18FEE9EFFA</RequestId>\\n</DeleteGrafanaResourceResponse>","errorExample":""}]', - 'title' => 'DeleteGrafanaResource', - ], - 'UninstallPromCluster' => [ - 'summary' => 'Releases a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumExceptionStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B6A00968-82A8-4F14-9D1B-B53827DB****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"ThreadId\\": \\"16643\\",\\n \\"Lines\\": [\\n \\"\\\\\\"CoreFoundation 0x00000001aa66a678 0x00000001aa57e000 + 968312\\\\\\",\\\\n \\\\\\"libobjc.A.dylib 0x00000001a2917c80 0x00000001a28ec000 + 179328\\\\\\"\\"\\n ],\\n \\"CrashReason\\": \\"EXC_BAD_ACCESS / KERN_INVALID_ADDRESS\\",\\n \\"CrashAddress\\": \\"0x1\\",\\n \\"ThreadInfoList\\": [\\n {\\n \\"ThreadTag\\": \\"Thread 0 (crashed)\\",\\n \\"ThreadDetail\\": \\" \\\\\\"0 libsystem_platform.dylib + 0x1ab5\\\\\\\\n rax = 0x0000000000000001 rdx = 0x0000000000000064\\\\\\\\n rcx = 0xffffffffffffffff rbx = 0x0000000107701bd0\\\\\\\\n rsi = 0x0101010101010101 rdi = 0x0000000000000001\\\\\\\\n rbp = 0x00007ff7b8d64300 rsp = 0x00007ff7b8d64300\\\\\\\\n r8 = 0x000000000000000a r9 = 0x0000000000000000\\\\\\\\n r10 = 0x0000000000000001 r11 = 0x0000000000000247\\\\\\\\n r12 = 0x00007ff7b8d64390 r13 = 0x0000000000000000\\\\\\\\n r14 = 0x000000010719d770 r15 = 0x00007ff7b8d64500\\\\\\\\n rip = 0x00007ff807a40ab5\\\\\\\\n Found by: given as instruction pointer in context\\\\\\\\n 1 alibabacloud_rum_example + 0x2ad1\\\\\\\\n rbp = 0x00007ff7b8d64310 rsp = 0x00007ff7b8d64310\\\\\\\\n rip = 0x000000010719dad1\\\\\\\\n Found by: previous frame\'s frame pointer\\\\\\\\n 2 alibabacloud_rum_example + 0x2a3b\\\\\\\\n rbp = 0x00007ff7b8d64360 rsp = 0x00007ff7b8d64320\\\\\\\\n rip = 0x000000010719da3b\\\\\\\\n Found by: previous frame\'s frame pointer\\\\\\\\n 3 0x7ff807688345\\\\\\\\n rbp = 0x00007ff7b8d64580 rsp = 0x00007ff7b8d64370\\\\\\\\n rip = 0x00007ff807688345\\\\\\\\n Found by: previous frame\'s frame pointer\\\\\\"\\\\n\\"\\n }\\n ],\\n \\"ModuleName\\": \\"alibabacloud_rum_example\\",\\n \\"Uuid\\": \\"9032259CEB9130E780C6DE8FDECCD7990\\",\\n \\"BinaryImages\\": \\"\\\\\\"04B5B216682E40BF9BBE9698E3F98CAA0,libcurl.4.dylib;7878DB3CF21A3C13A203B7E3B0FA66250,libalibabacloud_rum.dylib;0F9F96FE6B1C3253A33AC9E4A0C2A3860,libsystem_kernel.dylib;3DF3256F466E37BCB995A5A9956E14150,libsystem_pthread.dylib;000000000000000000000000000000000,Security;EA4B83A319EB3E15B22CDF035DBD49250,alibabacloud_rum_example;710BB12EEEC744BAB41D1849CA3AD8021,LTSDK.pdb;EE330BA9C49E4730AA15A2B7C0BB2CAE1,JBLive.pdb\\\\\\"\\"\\n }\\n}","type":"json"}]', + ], + 'GetRumOcuStatisticData' => [ + 'summary' => 'Queries the observability capacity unit (OCU) usage data of Real User Monitoring (RUM).', + 'methods' => ['get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AliyunLang', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '语言环境, 默认为中文 zh | en', - 'description' => 'Language environment(If left blank, defaults to zh):'."\n" - .'- zh'."\n" - .'- en', - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1600063200000', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1687849260000', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'QueryType', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], + 'schema' => ['description' => 'The type of the query. To query non-time series data, set the value to INSTANT. To query time series data, set the value to TIME_SERIES.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TIME_SERIES', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to find logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '53980F48-DE82-53A1-9ADE-D2629226DD9A', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => 'The filter condition. Three types of filter conditions are provided:'."\n" + ."\n" + .'* Application name: pid (Note that the application name is displayed, but the application ID is actually specified)'."\n" + .'* Application type: siteType'."\n" + .'* Data type: dataType'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the filter condition. Three types of filter conditions are provided:'."\n" + ."\n" + .'* Application name: pid (Note that the application name is displayed, but the application ID is actually specified)'."\n" + .'* Application type: siteType'."\n" + .'* Data type: dataType'."\n", 'type' => 'string', 'required' => false, 'example' => 'pid', 'title' => ''], + 'OpType' => ['description' => 'The type of the operator. Valid value: in.'."\n", 'type' => 'string', 'required' => false, 'example' => 'in', 'title' => ''], + 'Value' => ['description' => 'The value of the filter condition. The value is a JSON array of strings.'."\n", 'type' => 'any', 'required' => false, 'example' => '["b590xxxxx@2dcbxxxxx9", "b590xxxxx@2dcbxxxxx8"]', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'description' => '', + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"53980F48-DE82-53A1-9ADE-D2629226DD9A\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<UninstallPromClusterResponse>\\n <Data>true</Data>\\n <RequestId>53980F48-DE82-53A1-9ADE-D2629226DD9A</RequestId>\\n</UninstallPromClusterResponse>","errorExample":""}]', - 'title' => 'UninstallPromCluster', - ], - 'QueryPromInstallStatus' => [ - 'summary' => 'Queries whether the Prometheus agent is installed on a cluster.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', + 'name' => 'Group', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'description' => 'The grouping fields. Valid values:'."\n" + ."\n" + .'* siteType: The total number of OCUs is grouped by application type.'."\n" + .'* dataType: The total number of OCUs is grouped by data type.'."\n" + .'* pid: The total number of OCUs is grouped by application ID.'."\n" + .'* appName: The total number of OCUs is grouped by application name.'."\n" + .'* startTime: The total number of OCUs is grouped by start time.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The grouping key.'."\n", 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' "siteType",'."\n" + .' "dataType"'."\n" + .']', 'title' => ''], 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ClusterId', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '100', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ @@ -20507,45 +15369,65 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => '内部错误，请联系客户人员。', 'title' => ''], 'Data' => [ 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'isControllerInstalled' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'true: The call was successful. false: The call fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Items' => [ + 'description' => 'The queried data.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the queried data, in the JSON Map format.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'any', 'description' => 'The queried data.'."\n", 'example' => '{'."\n" + .' "totalChargedSessionCount": "11008",'."\n" + .' "__time__": 1717948800,'."\n" + .' "appName": "主控制台",'."\n" + .' "totalOcu": "55",'."\n" + .' "startTime": "1719244800",'."\n" + .' "pid": "b5xxxxxuqs@1f59cxxxxxxxxxb",'."\n" + .' "totalCount": "11"'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Page' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Complete' => ['description' => 'Indicates whether the next page exists.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": {\\n \\"isControllerInstalled\\": true\\n }\\n}","type":"json"}]', - 'title' => 'QueryPromInstallStatus', - ], - 'ListPrometheusGlobalView' => [ - 'summary' => 'Creates a global aggregation instance in Prometheus Service and obtains the list of global aggregation instances.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"内部错误，请联系客户人员。\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"key\\": \\"{\\\\n \\\\\\"totalChargedSessionCount\\\\\\": \\\\\\"11008\\\\\\",\\\\n \\\\\\"__time__\\\\\\": 1717948800,\\\\n \\\\\\"appName\\\\\\": \\\\\\"主控制台\\\\\\",\\\\n \\\\\\"totalOcu\\\\\\": \\\\\\"55\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1719244800\\\\\\",\\\\n \\\\\\"pid\\\\\\": \\\\\\"b5xxxxxuqs@1f59cxxxxxxxxxb\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": \\\\\\"11\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"Total\\": 100,\\n \\"Page\\": 1,\\n \\"PageSize\\": 100,\\n \\"Complete\\": true\\n }\\n}","type":"json"}]', + 'title' => 'GetRumOcuStatisticData', + 'description' => 'You can query the usage data for the current day at any time. You can query the usage data for the previous day only after 8:00 today.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-08-16T07:53:56.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetRumUploadFiles' => [ + 'summary' => 'Retrieves Real User Monitoring (RUM) related files, including symbol tables and SourceMap files.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -20553,492 +15435,272 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AppType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The file type. Valid values:'."\n" + ."\n" + .'- source-map: SourceMap file.'."\n" + .'- mapping: Android symbol table file.'."\n" + .'- dsym: iOS dSYM file.', 'type' => 'string', 'required' => false, 'example' => 'source-map', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The list of global aggregation instances. The value of this parameter is a string in the JSON format.'."\n", - 'type' => 'string', - 'example' => '\\[ {groupName: "the name of the global aggregation instance", clusterId: "global-v2-clusterid", endpoint: "cn-hangzhou"}, // ..... more items ]'."\n", - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'DBDCE95A-A0DD-5FC5-97CC-EEFC3D814385', - ], - 'Code' => [ - 'description' => 'Status code. Description 200 means success.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'More information.', - 'type' => 'string', - 'example' => 'success', - ], - ], - 'description' => '', - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[ {groupName: \\\\\\"聚合实例名称\\\\\\", clusterId: \\\\\\"global-v2-clusterid\\\\\\", endpoint: \\\\\\"cn-hangzhou\\\\\\"}, // ..... more items ]\\",\\n \\"RequestId\\": \\"DBDCE95A-A0DD-5FC5-97CC-EEFC3D814385\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPrometheusGlobalViewResponse>\\n <Data>[ {groupName: \\"聚合实例名称\\", clusterId: \\"global-v2-clusterid\\", endpoint: \\"cn-hangzhou\\"}, // ..... more items ]</Data>\\n <RequestId>DBDCE95A-A0DD-5FC5-97CC-EEFC3D814385</RequestId>\\n</ListPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'ListPrometheusGlobalView', - ], - 'GetPrometheusGlobalView' => [ - 'summary' => 'Queries the information about a global aggregation instance.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'aoxxxxxly@741623b4e91****', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GlobalViewClusterId', + 'name' => 'VersionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', - ], + 'schema' => ['description' => 'The file version number. If this parameter is not specified, files of all versions are returned by default.', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'string', - 'example' => '{ "clusterId":"The ID of the global aggregation instance.", "groupName":"The name of the global aggregation instance.", "dataSources":\\[ { "sourceName":"The name of the data source.- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId" }, // more datasources ] }'."\n", - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '743AD493-D006-53BD-AAEC-DDCE7FB68EA7', - ], - 'Code' => [ - 'description' => 'Status code. 200 is success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Returns a hint message for the result.', - 'type' => 'string', - 'example' => 'success', - ], - ], - 'description' => '', - ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int32', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"{ \\\\\\"clusterId\\\\\\":\\\\\\"聚合实例ClusterId\\\\\\", \\\\\\"groupName\\\\\\":\\\\\\"聚合实例名称\\\\\\", \\\\\\"dataSources\\\\\\":[ { \\\\\\"sourceName\\\\\\":\\\\\\"数据源名称- ArmsPrometheus No.1\\\\\\", \\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\", \\\\\\"userId\\\\\\":\\\\\\"UserID\\\\\\", \\\\\\"clusterId\\\\\\":\\\\\\"ClusterId\\\\\\" }, // more datasources ] }\\",\\n \\"RequestId\\": \\"743AD493-D006-53BD-AAEC-DDCE7FB68EA7\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPrometheusGlobalViewResponse>\\n <Data>{ \\"clusterId\\":\\"聚合实例ClusterId\\", \\"groupName\\":\\"聚合实例名称\\", \\"dataSources\\":[ { \\"sourceName\\":\\"数据源名称- ArmsPrometheus No.1\\", \\"sourceType\\":\\"AlibabaPrometheus\\", \\"userId\\":\\"UserID\\", \\"clusterId\\":\\"ClusterId\\" }, // more datasources ] }</Data>\\n <RequestId>743AD493-D006-53BD-AAEC-DDCE7FB68EA7</RequestId>\\n</GetPrometheusGlobalViewResponse>","errorExample":""}]', - 'title' => 'GetPrometheusGlobalView', - ], - 'CheckServiceStatus' => [ - 'summary' => 'Checks the status of a service in the current cluster, such as whether the service is activated and whether the payment is overdue.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '44423', - 'abilityTreeNodes' => [ - 'FEATUREarms7LDEBN', + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'SvcCode', + 'name' => 'Workspace', 'in' => 'query', - 'schema' => [ - 'description' => 'The service code of an Alibaba Cloud service. The service code of Managed Service for Prometheus is prometheus.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'prometheus', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ServiceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned struct.'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****'], + 'Code' => ['description' => 'The status code. A value of 200 indicates success. Other values indicate exceptions.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned when the call fails.', 'type' => 'string', 'example' => '内部错误，请联系管理员。', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the query is successful. Valid values:'."\n" + ."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true.'."\n" - .'* false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to find logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '5710C923-AD09-4293-9E11-DCBE3D15F8D4', + 'description' => 'The file list.', + 'type' => 'object', + 'properties' => [ + 'FileList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'FileName' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Uuid' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'Size' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + 'LastModifiedTime' => ['type' => 'any', 'description' => '', 'title' => '', 'example' => ''], + 'VersionId' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'NextToken' => ['type' => 'string', 'description' => '', 'title' => '', 'example' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"5710C923-AD09-4293-9E11-DCBE3D15F8D4\\"\\n}","type":"json"}]', - 'title' => 'CheckServiceStatus', - ], - 'GetPrometheusApiToken' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Retrieve RUM files', + 'description' => 'Real User Monitoring is currently available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.', + 'changeSet' => [ + ['createdAt' => '2025-08-22T06:39:14.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-08-15T03:51:32.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-08-16T07:53:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-25T13:00:55.000Z', 'description' => 'Request parameters changed'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ + 'ramActions' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Token' => [ - 'description' => 'The token required for integrating Prometheus Service.'."\n", - 'type' => 'string', - 'example' => '6dcbb77ef4ba6ef5466b5debf9e2****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumUploadFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - 'description' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Token\\": \\"6dcbb77ef4ba6ef5466b5debf9e2****\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\"\\n}","errorExample":""},{"type":"xml","example":"<GetPrometheusApiTokenResponse>\\n\\t<RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n\\t<Token>6dcbb77ef4ba6ef5466b5debf9e2****</Token>\\n</GetPrometheusApiTokenResponse>","errorExample":""}]', - 'title' => 'GetPrometheusApiToken', - 'summary' => 'Queries the token required for integrating Prometheus Service.', - 'description' => 'None.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"内部错误，请联系管理员。\\",\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"FileList\\": [\\n {\\n \\"FileName\\": \\"\\",\\n \\"Uuid\\": \\"\\",\\n \\"Size\\": \\"\\",\\n \\"LastModifiedTime\\": \\"\\",\\n \\"VersionId\\": \\"\\"\\n }\\n ],\\n \\"NextToken\\": \\"\\"\\n }\\n}","type":"json"}]', ], - 'GetExploreUrl' => [ - 'summary' => 'Enables the Explore feature of Grafana.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSourceMapInfo' => [ + 'summary' => 'Obtains the details of the SourceMap file uploaded in Browser Monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'ID', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the SourceMap file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Keyword', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c9cc4c5e220f8461f9d71b6ec6e******', - ], + 'schema' => ['description' => 'The keyword in the file name. The files are searched by keyword.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test', 'title' => ''], ], [ - 'name' => 'Type', + 'name' => 'OrderField', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the Grafana data source.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'loki' => 'loki', - 'prometheus' => 'prometheus', - ], - 'example' => 'prometheus', - ], + 'schema' => ['description' => 'The criterion by which the files are sorted. Valid values:'."\n" + ."\n" + .'* version: The files are sorted by version.'."\n" + .'* uploadTime: The files are sorted by upload time.'."\n", 'type' => 'string', 'required' => false, 'example' => 'version', 'title' => ''], ], [ - 'name' => 'Expression', + 'name' => 'AscendingSequence', 'in' => 'query', - 'schema' => [ - 'description' => 'The query statement that corresponds to the data source.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - '{level="WARN"}' => '{level="WARN"}', - '{level="ERROR"}' => '{level="ERROR"}', - ], - 'example' => '{app="buy2"}', - ], + 'schema' => ['description' => 'The order in which the files are sorted. Valid values:'."\n" + ."\n" + .'* true: ascending order'."\n" + .'* false: descending order'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => ['description' => 'The version of the SourceMap file.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'Response parameters'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The prompt information of the returned result.', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Whether the operation was successful:'."\n" - .'- true: the operation was successful'."\n" - .'- false: the operation failed', - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'SourceMapList' => [ + 'description' => 'The details of the SourceMap file.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Fid' => ['description' => 'The ID of the SourceMap file.'."\n", 'type' => 'string', 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', 'title' => ''], + 'FileName' => ['description' => 'The name of the SourceMap file.'."\n", 'type' => 'string', 'example' => 'test.sourcemap.js', 'title' => ''], + 'Size' => ['description' => 'The size of the file. Unit: KB.'."\n", 'type' => 'string', 'example' => '201223', 'title' => ''], + 'UploadTime' => ['description' => 'The timestamp that indicates when the file was uploaded.'."\n", 'type' => 'string', 'example' => '1590657842000', 'title' => ''], + 'Version' => ['description' => 'The version of the file.'."\n", 'type' => 'string', 'example' => '0.0.0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"-\\",\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetExploreUrl', - ], - 'ListDashboards' => [ - 'summary' => 'Queries the Grafana dashboards of a Container Service for Kubernetes (ACK) cluster.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"SourceMapList\\": [\\n {\\n \\"Fid\\": \\"atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js\\",\\n \\"FileName\\": \\"test.sourcemap.js\\",\\n \\"Size\\": \\"201223\\",\\n \\"UploadTime\\": \\"1590657842000\\",\\n \\"Version\\": \\"0.0.0\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetSourceMapInfo', + 'changeSet' => [ + ['createdAt' => '2022-07-27T08:48:27.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSourceMapInfo'], + ], ], + 'ramActions' => [], + ], + 'GetStack' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', + 'name' => 'TraceID', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACK cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The trace ID. It is displayed on the **Trace Explorer** page in the Application Real-Time Monitoring Service (ARMS) console.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0a5800611641470044457853******', 'title' => ''], ], [ - 'name' => 'ClusterType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'Valid values: ACK, ASK, cloud-product-prometheus, and Node. You can query the dashboards of a virtual cluster by specifying the cluster type. For InfluxDB, set this parameter to `cloud-product-prometheus`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Node', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Language', + 'name' => 'RpcID', 'in' => 'query', - 'schema' => [ - 'description' => 'The language of the returned Grafana dashboard. Valid values: en and zh. Default value: en.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'en', - ], + 'schema' => ['description' => 'The ID of the remote procedure call (RPC) mode. You can obtain the ID by calling the **GetTrace** operation.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '0.1', 'title' => ''], ], [ - 'name' => 'Title', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The dashboard title. The dashboard title can be changed. We recommend that you specify the **DashboardName** parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ApiServer', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application. For more information about how to obtain the PID, see [Obtain the PID of an application](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'eb4zdose6v@36bab313a******', 'title' => ''], ], [ - 'name' => 'Product', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The cloud service code. This parameter is required if you set the ClusterType parameter to `cloud-product-prometheus`. The following cloud services are available: Serverless App Engine, Microservices Engine, Message Queue for Apache RocketMQ, Lindorm, Message Queue for Apache Kafka, ApsaraDB for ClickHouse, Data Lake Analytics, Message Queue for RabbitMQ, ApsaraDB for MongoDB, Time Series Database (TSDB) for InfluxDB, MSE Cloud-native Gateway, Grafana Service, SchedulerX, Global Transaction Service, Enterprise Distributed Application Service, Machine Learning Platform for AI - Elastic Algorithm Service (EAS), Application High Availability Service, and Performance Testing.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], + 'schema' => ['description' => 'The entry timestamp of the method call. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1728351543000', 'title' => ''], ], [ - 'name' => 'RecreateSwitch', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The exit timestamp of the method call. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1728355143000', 'title' => ''], ], [ - 'name' => 'DashboardName', + 'name' => 'SpanID', 'in' => 'query', - 'schema' => [ - 'description' => 'The unique names of the dashboards. You can query dashboards by specifying their names. The **dashboard title** can be changed whereas the **dashboard name** cannot. You can specify multiple names and separate them with commas (,), for example, `k8s-event,k8s-overview`. A dashboard may have multiple versions. If you want to specify a version, you can add version information after the name, for example, `k8s-event:v1,k8s-overview:latest`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'k8s-node-overview', - ], + 'schema' => ['description' => 'The span ID of the trace. It is displayed on the Trace Explorer page in the ARMS console.', 'type' => 'string', 'required' => false, 'example' => '88c32dfa4b******', 'title' => ''], ], ], 'responses' => [ @@ -21046,979 +15708,872 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'DashboardVos' => [ - 'description' => 'The information about the Grafana dashboard.'."\n", + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => 'B34C3A43-A901-5F94-9DAD-758CE4******', 'title' => ''], + 'StackInfo' => [ + 'description' => 'The method stack details.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the Grafana dashboard.'."\n", 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the Grafana dashboard. Valid values:'."\n" - ."\n" - .'* `dash-db`: a dashboard'."\n" - .'* `dash-folder`: a folder that can include a dashboard'."\n", - 'type' => 'string', - 'example' => 'dash-db', - ], - 'Time' => [ - 'description' => 'The time when the Grafana dashboard was created. The value is a timestamp. Unit: seconds.'."\n", - 'type' => 'string', - 'example' => '1590136924', - ], - 'NeedUpdate' => [ - 'description' => 'Indicates whether the Grafana dashboard has a new version that is available for upgrade.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Kind' => [ - 'description' => 'The category of the Grafana dashboard. Valid values: BASIC, THIRD, LIMIT, and CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'BASIC', - ], - 'Language' => [ - 'description' => 'The language of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'en', - ], - 'Url' => [ - 'description' => 'The complete URL of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', - ], - 'HttpsUrl' => [ - 'description' => 'The URL of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', - ], - 'DashboardType' => [ - 'description' => 'The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication.'."\n", - 'type' => 'string', - 'example' => 'Node', - ], - 'Exporter' => [ - 'description' => 'The type of the exporter access source. Valid values:'."\n" - ."\n" - .'* Prometheus'."\n" - .'* Node'."\n" - .'* GPU'."\n" - .'* Redis'."\n" - .'* MySQL'."\n" - .'* Kafka'."\n" - .'* NGINX V2'."\n" - .'* Nginx'."\n" - .'* ZooKeeper'."\n" - .'* MongoDB'."\n" - .'* RabbitMQ'."\n" - .'* PostgreSQL'."\n" - .'* Kubernetes'."\n" - .'* Client Library'."\n" - .'* Elasticsearch'."\n" - .'* RocketMQ'."\n", - 'type' => 'string', - 'example' => 'Nginx', - ], - 'Version' => [ - 'description' => 'The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard.'."\n", - 'type' => 'string', - 'example' => 'v2', - ], - 'IsArmsExporter' => [ - 'description' => 'Indicates whether the exporter is provided by Application Real-Time Monitoring Service (ARMS).'."\n" - ."\n" - .'* `true:` The exporter is provided by ARMS.'."\n" - .'* `false:`: The exporter is not provided by ARMS.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'HttpUrl' => [ - 'description' => 'The URL of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', - ], - 'Title' => [ - 'description' => 'The title of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'ApiServer', - ], - 'Name' => [ - 'description' => 'The name of the Grafana dashboard. This parameter is different from the **Title** parameter as this parameter cannot be changed.'."\n", - 'type' => 'string', - 'example' => 'k8s-node-overview', - ], - 'Id' => [ - 'description' => 'The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => '1100**', - ], - 'Uid' => [ - 'description' => 'The unique identifier of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => '1131971649496228-*****-59', - ], - 'Tags' => [ - 'description' => 'The tags of the Grafana dashboard.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => '["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]', - ], - ], - 'I18nChild' => [ - 'description' => 'The information about the Grafana dashboard.'."\n", + 'StartTime' => ['description' => 'The start time of the call method.', 'type' => 'integer', 'format' => 'int64', 'example' => '1653555396', 'title' => ''], + 'Exception' => ['description' => 'The error message.', 'type' => 'string', 'example' => 'java.lang.NullPointerException', 'title' => ''], + 'Api' => ['description' => 'The name of the operation.', 'type' => 'string', 'example' => 'Tomcat Servlet Process', 'title' => ''], + 'Line' => ['description' => 'The number of rows in the method stack information.', 'type' => 'string', 'example' => '34', 'title' => ''], + 'Duration' => ['description' => 'The duration. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'example' => '32', 'title' => ''], + 'RpcId' => ['description' => 'The ID of the RPC mode.', 'type' => 'string', 'example' => '0.1', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => '/com/test', 'title' => ''], + 'CallCount' => ['description' => 'The number of times the method is called.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'ExtInfo' => [ + 'description' => 'The information about the array object.', 'type' => 'object', 'properties' => [ - 'Type' => [ - 'description' => 'The type of the Grafana dashboard. Valid values:'."\n" - ."\n" - .'* `dash-db`: a dashboard'."\n" - .'* `dash-folder`: a folder that can include a dashboard'."\n", - 'type' => 'string', - 'example' => 'dash-db', - ], - 'Time' => [ - 'description' => 'The time when the Grafana dashboard was created. The value is a timestamp.'."\n", - 'type' => 'string', - 'example' => '1590136924', - ], - 'NeedUpdate' => [ - 'description' => 'Indicates whether the Grafana dashboard has a new version that is available for upgrade.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Kind' => [ - 'description' => 'The category of the Grafana dashboard. Valid values: BASIC, THIRD, LIMIT, and CUSTOM.'."\n", - 'type' => 'string', - 'example' => 'BASIC', - ], - 'Language' => [ - 'description' => 'The language of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'Url' => [ - 'description' => 'The complete URL of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', - ], - 'HttpsUrl' => [ - 'description' => 'The URL of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', - ], - 'DashboardType' => [ - 'description' => 'The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication.'."\n", - 'type' => 'string', - 'example' => 'Node', - ], - 'Exporter' => [ - 'description' => 'The type of the exporter access source. Valid values:'."\n" - ."\n" - .'* Prometheus'."\n" - .'* Node'."\n" - .'* GPU'."\n" - .'* Redis'."\n" - .'* MySQL'."\n" - .'* Kafka'."\n" - .'* NGINX V2'."\n" - .'* Nginx'."\n" - .'* ZooKeeper'."\n" - .'* MongoDB'."\n" - .'* RabbitMQ'."\n" - .'* PostgreSQL'."\n" - .'* Kubernetes'."\n" - .'* Client Library'."\n" - .'* Elasticsearch'."\n" - .'* RocketMQ'."\n", - 'type' => 'string', - 'example' => 'Nginx', - ], - 'Version' => [ - 'description' => 'The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard.'."\n", - 'type' => 'string', - 'example' => 'v2', - ], - 'IsArmsExporter' => [ - 'description' => 'Indicates whether the exporter is provided by ARMS.'."\n" - ."\n" - .'* `true:` The exporter is provided by ARMS.'."\n" - .'* `false:`: The exporter is not provided by ARMS.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'HttpUrl' => [ - 'description' => 'The URL of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', - ], - 'Title' => [ - 'description' => 'The title of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => 'ApiServer', - ], - 'Name' => [ - 'description' => 'The name of the Grafana dashboard. This parameter is different from the **Title** parameter as this parameter cannot be changed.'."\n", - 'type' => 'string', - 'example' => 'k8s-node-overview', - ], - 'Id' => [ - 'description' => 'The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => '1100**', - ], - 'Uid' => [ - 'description' => 'The unique identifier of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => '1131971649496228-*****-59', - ], - 'Tags' => [ - 'description' => 'The tags of the Grafana dashboard.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags of the Grafana dashboard.'."\n", - 'type' => 'string', - 'example' => '["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]', - ], - ], + 'Type' => ['description' => 'The type of the custom parameter.', 'type' => 'string', 'example' => '41', 'title' => ''], + 'Info' => ['description' => 'The content of the custom parameter.', 'type' => 'string', 'example' => 'input=254275&', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'PrometheusServiceOpened' => [ - 'description' => 'Whether or not to turn on Prometheus service.', - 'type' => 'string', - 'example' => 'true', - ], - 'EnvironmentId' => [ - 'description' => 'The ID of the environment instance.'."\n", - 'type' => 'string', - 'example' => 'env-ebd54733482581fc8c4237******', - ], - 'GrafanaServiceOpened' => [ - 'description' => 'Indicates whether Managed Service for Grafana is activated.'."\n", - 'type' => 'string', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"DashboardVos\\": [\\n {\\n \\"Type\\": \\"dash-db\\",\\n \\"Time\\": \\"1590136924\\",\\n \\"NeedUpdate\\": false,\\n \\"Kind\\": \\"BASIC\\",\\n \\"Language\\": \\"en\\",\\n \\"Url\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"HttpsUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"DashboardType\\": \\"Node\\",\\n \\"Exporter\\": \\"Nginx\\",\\n \\"Version\\": \\"v2\\",\\n \\"IsArmsExporter\\": false,\\n \\"HttpUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"Title\\": \\"ApiServer\\",\\n \\"Name\\": \\"k8s-node-overview\\",\\n \\"Id\\": \\"1100**\\",\\n \\"Uid\\": \\"1131971649496228-*****-59\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"arms-k8s\\\\\\",\\\\\\"ccc8ce1fe0c9543629e39ee657e34****\\\\\\"]\\"\\n ],\\n \\"I18nChild\\": {\\n \\"Type\\": \\"dash-db\\",\\n \\"Time\\": \\"1590136924\\",\\n \\"NeedUpdate\\": false,\\n \\"Kind\\": \\"BASIC\\",\\n \\"Language\\": \\"zh\\",\\n \\"Url\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"HttpsUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"DashboardType\\": \\"Node\\",\\n \\"Exporter\\": \\"Nginx\\",\\n \\"Version\\": \\"v2\\",\\n \\"IsArmsExporter\\": false,\\n \\"HttpUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"Title\\": \\"ApiServer\\",\\n \\"Name\\": \\"k8s-node-overview\\",\\n \\"Id\\": \\"1100**\\",\\n \\"Uid\\": \\"1131971649496228-*****-59\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"arms-k8s\\\\\\",\\\\\\"ccc8ce1fe0c9543629e39ee657e34****\\\\\\"]\\"\\n ]\\n }\\n }\\n ],\\n \\"PrometheusServiceOpened\\": \\"true\\",\\n \\"EnvironmentId\\": \\"env-ebd54733482581fc8c4237******\\",\\n \\"GrafanaServiceOpened\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDashboardsResponse>\\n <RequestId>2A0CEDF1-06FE-44AC-8E21-21A5BE65****</RequestId>\\n <DashboardVos>\\n <Type>dash-db</Type>\\n <Time>1590136924</Time>\\n <NeedUpdate>false</NeedUpdate>\\n <Kind>BASIC</Kind>\\n <Url>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s</Url>\\n <HttpsUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s</HttpsUrl>\\n <DashboardType>Node</DashboardType>\\n <Exporter>Nginx</Exporter>\\n <Version>v2</Version>\\n <IsArmsExporter>false</IsArmsExporter>\\n <HttpUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s</HttpUrl>\\n <Title>ApiServer</Title>\\n <Name>k8s-node-overview</Name>\\n <Id>1100**</Id>\\n <Uid>1131971649496228-*****-59</Uid>\\n <Tags>[\\"arms-k8s\\",\\"ccc8ce1fe0c9543629e39ee657e34****\\"]</Tags>\\n </DashboardVos>\\n</ListDashboardsResponse>","errorExample":""}]', - 'title' => 'ListDashboards', - 'description' => 'None.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListClusterFromGrafana' => [ - 'summary' => 'Queries all Grafana dashboards in a specified region.', - 'methods' => [ - 'post', - 'get', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'GetStack', + 'summary' => 'Queries the information of a method stack.', + 'changeSet' => [ + ['createdAt' => '2024-10-08T03:39:44.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStack'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"B34C3A43-A901-5F94-9DAD-758CE4******\\",\\n \\"StackInfo\\": [\\n {\\n \\"StartTime\\": 1653555396,\\n \\"Exception\\": \\"java.lang.NullPointerException\\",\\n \\"Api\\": \\"Tomcat Servlet Process\\",\\n \\"Line\\": \\"34\\",\\n \\"Duration\\": 32,\\n \\"RpcId\\": \\"0.1\\",\\n \\"ServiceName\\": \\"/com/test\\",\\n \\"CallCount\\": \\"1\\",\\n \\"ExtInfo\\": {\\n \\"Type\\": \\"41\\",\\n \\"Info\\": \\"input=254275&\\"\\n }\\n }\\n ]\\n}","type":"json"}]', + ], + 'GetSyntheticMonitors' => [ + 'summary' => 'Obtains detection points.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'description' => 'The query conditions.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskType' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'MonitorCategory' => ['description' => 'The type of the monitoring point. Valid values: 1: PC. 2: mobile device.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + 'Network' => ['description' => 'The network type. Valid values: 1: private network. 2: Internet.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'example' => '1', 'title' => ''], + ], 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the array object.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '6849D41E-EED4-5C00-89F9-6047BBD9DCB4', - ], - 'PromClusterList' => [ - 'description' => 'The cluster information.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FD473FF-5398-5A85-9BF6-7AB45561522F'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The list of monitoring points.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about the Grafana dashboards.'."\n", 'type' => 'object', 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the dashboard was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-11-16T08:49:34Z', - ], - 'CreateTime' => [ - 'description' => 'The time when the dashboard was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2021-12-09T02:05:04Z', - ], - 'UserId' => [ - 'description' => 'The ID of the Alibaba Cloud account to which the cluster belongs.'."\n", - 'type' => 'string', - 'example' => '1247285**', - ], - 'Options' => [ - 'description' => 'The custom parameter.'."\n", - 'type' => 'string', - 'example' => '{\'Option\': [\'betaTestApproved\']}', - ], - 'IsControllerInstalled' => [ - 'description' => 'Indicates whether the Prometheus agent was installed. Valid values:'."\n" - ."\n" - .'* true: The Prometheus agent was installed.'."\n" - .'* false: The Prometheus agent was not installed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AgentStatus' => [ - 'description' => 'The status of the Prometheus agent on the cluster. Valid values:'."\n" - ."\n" - .'* INSTALL_FAILED: The Prometheus agent failed to be installed.'."\n" - .'* INSTALL_SUCCEED: The Prometheus agent was installed.'."\n" - .'* NOT_REGISTER: You have not registered an Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => 'INSTALL_FAILED', - ], - 'Extra' => [ - 'description' => 'The extended fields. This parameter is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{\\"app_id\\":\\"bbd\\",\\"task_id\\":\\"4305ba5bf14942daa6e553ed91f46988\\"}', - ], - 'InstallTime' => [ - 'description' => 'The timestamp when the Prometheus agent was installed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1653532518000', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'ControllerId' => [ - 'description' => 'The controller ID.'."\n", - 'type' => 'string', - 'example' => '1092', - ], - 'PluginsJsonArray' => [ - 'description' => 'The list of nodejsonar logs.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'ClusterType' => [ - 'description' => 'The type of the cluster.'."\n", - 'type' => 'string', - 'example' => 'cloud-product-prometheus', - ], - 'ClusterName' => [ - 'description' => 'The name of the cluster.'."\n", - 'type' => 'string', - 'example' => 'ay-ads-hangzhou', - ], - 'StateJson' => [ - 'description' => 'The information about applications deployed in the cluster.'."\n", - 'type' => 'string', - 'example' => '{}', - ], - 'LastHeartBeatTime' => [ - 'description' => 'The time when the last heartbeat was reported.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1653532518000', - ], - 'NodeNum' => [ - 'description' => 'The number of nodes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '3', - ], - 'Id' => [ - 'description' => 'The ID of a database in the cluster.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '16136', - ], - 'ClusterId' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'example' => 'c0df7ad9db0ed43128925ca04774c469e', - ], + 'Country' => ['description' => 'The country.'."\n", 'type' => 'string', 'example' => '中国', 'title' => ''], + 'Region' => ['description' => 'The region.'."\n", 'type' => 'string', 'example' => '浙江', 'title' => ''], + 'City' => ['description' => 'The city.'."\n", 'type' => 'string', 'example' => '北京市', 'title' => ''], + 'CityCode' => ['description' => 'The city code.'."\n", 'type' => 'string', 'example' => '1100101', 'title' => ''], + 'Operator' => ['description' => 'The carrier.'."\n", 'type' => 'string', 'example' => '阿里云', 'title' => ''], + 'OperatorCode' => ['description' => 'The carrier code.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ClientType' => ['description' => 'The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'CanBeSelected' => ['description' => 'Indicates whether the monitoring point is selected. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Available' => ['description' => 'Indicates whether the monitoring point is available. Valid values: true and false.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Ipv6' => ['description' => 'Indicates whether IPv6 is supported. Valid values: 0: IPv6 is not supported. 1: IPv6 is supported.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6849D41E-EED4-5C00-89F9-6047BBD9DCB4\\",\\n \\"PromClusterList\\": [\\n {\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"UserId\\": \\"1247285**\\",\\n \\"Options\\": \\"{\'Option\': [\'betaTestApproved\']}\\",\\n \\"IsControllerInstalled\\": true,\\n \\"AgentStatus\\": \\"INSTALL_FAILED\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"app_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bbd\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"task_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4305ba5bf14942daa6e553ed91f46988\\\\\\\\\\\\\\"}\\",\\n \\"InstallTime\\": 1653532518000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ControllerId\\": \\"1092\\",\\n \\"PluginsJsonArray\\": \\"{}\\",\\n \\"ClusterType\\": \\"cloud-product-prometheus\\",\\n \\"ClusterName\\": \\"ay-ads-hangzhou\\",\\n \\"StateJson\\": \\"{}\\",\\n \\"LastHeartBeatTime\\": 1653532518000,\\n \\"NodeNum\\": 3,\\n \\"Id\\": 16136,\\n \\"ClusterId\\": \\"c0df7ad9db0ed43128925ca04774c469e\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListClusterFromGrafanaResponse>\\n <RequestId>6849D41E-EED4-5C00-89F9-6047BBD9DCB4</RequestId>\\n <PromClusterList>\\n <UserId>1247285**</UserId>\\n <Options>{\'Option\': [\'betaTestApproved\']}</Options>\\n <IsControllerInstalled>true</IsControllerInstalled>\\n <AgentStatus>INSTALL_FAILED</AgentStatus>\\n <Extra>{\\\\\\"app_id\\\\\\":\\\\\\"bbd\\\\\\",\\\\\\"task_id\\\\\\":\\\\\\"4305ba5bf14942daa6e553ed91f46988\\\\\\"}</Extra>\\n <InstallTime>1653532518000</InstallTime>\\n <RegionId>cn-beijing</RegionId>\\n <ControllerId>1092</ControllerId>\\n <PluginsJsonArray>{}</PluginsJsonArray>\\n <ClusterType>cloud-product-prometheus</ClusterType>\\n <ClusterName>ay-ads-hangzhou</ClusterName>\\n <StateJson>{}</StateJson>\\n <LastHeartBeatTime>1653532518000</LastHeartBeatTime>\\n <NodeNum>3</NodeNum>\\n <Id>16136</Id>\\n <ClusterId>c0df7ad9db0ed43128925ca04774c469e</ClusterId>\\n </PromClusterList>\\n</ListClusterFromGrafanaResponse>","errorExample":""}]', - 'title' => 'ListClusterFromGrafana', - ], - 'GetRecordingRule' => [ - 'summary' => 'Obtains the recording rule of a cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'Data' => [ - 'description' => 'The recording rule.'."\n", - 'type' => 'string', - 'example' => '--- groups: - name: "recording_demo" rules: - expr: "sum(jvm_memory_max_bytes)" record: "rate_coredns_demo"', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates a successful request, whereas others indicate a failed request.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], - ], - ], + 'title' => 'GetSyntheticMonitors', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'changeSet' => [ + ['createdAt' => '2023-12-06T09:06:44.000Z', 'description' => 'Request parameters changed'], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticMonitors'], + ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"Data\\": \\"--- groups: - name: \\\\\\"recording_demo\\\\\\" rules: - expr: \\\\\\"sum(jvm_memory_max_bytes)\\\\\\" record: \\\\\\"rate_coredns_demo\\\\\\"\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<GetRecordingRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <Data>--- groups: - name: \\"recording_demo\\" rules: - expr: \\"sum(jvm_memory_max_bytes)\\" record: \\"rate_coredns_demo\\"</Data>\\n</GetRecordingRuleResponse>","errorExample":""}]', - 'title' => 'GetRecordingRule', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FD473FF-5398-5A85-9BF6-7AB45561522F\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": [\\n {\\n \\"Country\\": \\"中国\\",\\n \\"Region\\": \\"浙江\\",\\n \\"City\\": \\"北京市\\",\\n \\"CityCode\\": \\"1100101\\",\\n \\"Operator\\": \\"阿里云\\",\\n \\"OperatorCode\\": \\"1\\",\\n \\"ClientType\\": 1,\\n \\"CanBeSelected\\": true,\\n \\"Available\\": \\"true\\",\\n \\"Ipv6\\": 0\\n }\\n ]\\n}","type":"json"}]', ], - 'ListCmsInstances' => [ - 'summary' => 'Queries the collection of cloud services.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'GetSyntheticTaskDetail' => [ + 'summary' => 'Queries the details of a scheduled synthetic monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'n9p9o9o3se', - ], + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TypeFilter', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the cloud service integration. Valid values:'."\n" - ."\n" - .'* direct: self-monitoring'."\n" - .'* cms: Hybrid Cloud Monitoring'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'direct', - 'enum' => [ - 'cms', - 'direct', - ], - ], + 'schema' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'required' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => '', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => '', - 'type' => 'string', - 'example' => 'E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1', - ], - 'Data' => [ - 'description' => '', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****'], + 'TaskDetail' => [ + 'description' => 'The details of the task.'."\n", 'type' => 'object', 'properties' => [ - 'EnableTag' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Products' => [ - 'description' => '', + 'TaskId' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '19584', 'title' => ''], + 'TaskName' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => 'net-test', 'title' => ''], + 'Url' => ['description' => 'The URL for synthetic monitoring.'."\n", 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'MonitorList' => [ + 'description' => 'The detection points.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', 'type' => 'object', 'properties' => [ - 'Descr' => [ - 'description' => '', - 'type' => 'string', - 'example' => '-'."\n", - ], - 'Instance' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'cloudserver', - ], - 'Prod' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'face', - ], - 'Name' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'hologres', - ], - 'Id' => [ - 'description' => '', - 'type' => 'string', - 'example' => '20210', - ], - 'State' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'true', - ], - 'Time' => [ - 'description' => '', - 'type' => 'string', - 'example' => '1647852021000', - ], - 'Type' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'HOLOGRES', - ], - 'Url' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\u003d9\\u0026refresh\\u003d60s', + 'CityCode' => ['description' => 'The city code.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '11011XX', 'title' => ''], + 'NetServiceId' => ['description' => 'The ID of the network service.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'MonitorType' => ['description' => 'The type of the detection point.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'SendCount' => ['description' => 'The number of times that the system sends detection requests.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'1. 3: web page performance - IE'."\n" + .'2. 34: web page performance - Chrome'."\n" + .'3. 0: network quality'."\n" + .'4. 40: file download'."\n" + .'5. 7: API performance'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'IntervalTime' => ['description' => 'The interval at which synthetic monitoring is performed. Unit: minutes. Valid values:'."\n" + ."\n" + .'* 1'."\n" + .'* 5'."\n" + .'* 10'."\n" + .'* 15'."\n" + .'* 20'."\n" + .'* 30'."\n" + .'* 60'."\n" + .'* 120'."\n" + .'* 180'."\n" + .'* 240'."\n" + .'* 360'."\n" + .'* 480'."\n" + .'* 720'."\n" + .'* 1440'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'IntervalType' => ['description' => 'The interval type. Valid values:'."\n" + ."\n" + .'* 0: daily'."\n" + .'* 1: custom frequency'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ExtendInterval' => [ + 'description' => 'The frequency.'."\n", + 'type' => 'object', + 'properties' => [ + 'StartTime' => ['description' => 'The time when synthetic monitoring starts. Format: yyyy-MM-dd HH.'."\n", 'type' => 'string', 'example' => '2022-02-26 11:40', 'title' => ''], + 'EndTime' => ['description' => 'The time when synthetic monitoring ends. Format: `yyyy-MM-dd HH`.'."\n", 'type' => 'string', 'example' => '2022-05-03 11:40', 'title' => ''], + 'Days' => [ + 'description' => 'The day on which synthetic monitoring is performed. Valid values:'."\n" + ."\n" + .'* \\-1: every day'."\n" + .'* 0: Sunday'."\n" + .'* 1: Monday'."\n" + .'* 2: Tuesday'."\n" + .'* 3: Wednesday'."\n" + .'* 4: Thursday'."\n" + .'* 5: Friday'."\n" + .'* 6: Saturday'."\n", + 'type' => 'array', + 'items' => ['description' => 'The day on which synthetic monitoring is performed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'StartHour' => ['description' => 'The hour at which synthetic monitoring starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9', 'title' => ''], + 'StartMinute' => ['description' => 'The minute at which synthetic monitoring starts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'Endhour' => ['description' => 'The hour at which synthetic monitoring ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'EndMinute' => ['description' => 'The minute at which synthetic monitoring ends.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4.'."\n" + .'* 2: IPv6.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'Download' => [ + 'description' => 'The file download task.'."\n", + 'type' => 'object', + 'properties' => [ + 'DownloadTransmissionSize' => ['description' => 'The file size. Unit: KB.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'DownloadCustomHost' => ['description' => 'The custom host. Valid values:'."\n" + ."\n" + .'* 1: round robin'."\n" + .'* 0: random'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'DownloadCustomHostIp' => ['description' => 'The custom IP address of the host. Multiple IP addresses are separated with commas (,).'."\n", 'type' => 'string', 'example' => '168.23.45.1', 'title' => ''], + 'WhiteList' => ['description' => 'The whitelisted objects that are used to avoid DNS hijacking. Format: `<domain name>:<objects>`.'."\n" + ."\n" + .'> WAP networks do not support hijacking.'."\n", 'type' => 'string', 'example' => '[{\\"src\\":\\"211.154.166.174\\"}]', 'title' => ''], + 'DownloadKernel' => ['description' => 'The kernel type. Valid values:'."\n" + ."\n" + .'* 1: curl'."\n" + .'* 0: WinInet'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'QuickProtocol' => ['description' => 'The QUIC protocol type. Valid values:'."\n" + ."\n" + .'* 1: HTTP/1'."\n" + .'* 2: HTTP/2'."\n" + .'* 3: http3'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring duration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'ConnectionTimeout' => ['description' => 'The timeout period of the file download task.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'VerifyWay' => ['description' => 'The method that is used to verify the response content. Valid values:'."\n" + ."\n" + .'* 0: no verification.'."\n" + .'* 1: exact match with the verification string.'."\n" + .'* 2: partial match with the verification string.'."\n" + .'* 3: MD5 verification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'ValidateKeywords' => ['description' => 'The keyword that is used in verification.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'DownloadRedirect' => ['description' => 'Indicates whether redirection is supported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'DownloadCustomHeaderContent' => ['description' => 'The items to be ignored in a certificate error. Multiple values are concatenated with vertical bars (|).'."\n", 'type' => 'string', 'example' => 'char', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Net' => [ + 'description' => 'The network synthetic monitoring task.'."\n", + 'type' => 'object', + 'properties' => [ + 'NetIcmpSwitch' => ['description' => 'Indicates whether ICMP test is enabled. Valid values:'."\n" + ."\n" + .'* 0: no.'."\n" + .'* 1: yes. If you set this parameter to 1, you must also set the Icmp parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetIcmpActive' => ['description' => 'The protocol type. Valid values:'."\n" + ."\n" + .'* 0 : ICMP'."\n" + .'* 1 : TCP'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetIcmpTimeout' => ['description' => 'The monitoring timeout period.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'NetIcmpInterval' => ['description' => 'The interval at which the synthetic monitoring task is executed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'NetIcmpNum' => ['description' => 'The number of packets.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'NetIcmpSize' => ['description' => 'The packet size.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'NetIcmpDataCut' => ['description' => 'Indicates whether packets are split. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetDnsQueryMethod' => ['description' => 'The DNS query method. Valid values:'."\n" + ."\n" + .'* 1: recursive'."\n" + .'* 2: iterative'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'NetDnsSwitch' => ['description' => 'Indicates whether DNS test is enabled. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetTraceRouteSwitch' => ['description' => 'Indicates whether Tracert test is enabled. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes. If you set this parameter to 1, you must also set the Tracert parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetTraceRouteTimeout' => ['description' => 'The monitoring timeout period. Valid values: 0 to 300. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'NetTraceRouteNum' => ['description' => 'The maximum number of active detection points.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'WhiteList' => ['description' => 'The whitelisted objects that are used to avoid DNS hijacking. Format: `<domain name>:<objects>`.'."\n" + ."\n" + .'> WAP networks do not support hijacking.'."\n", 'type' => 'string', 'example' => '119.119.53.156/32', 'title' => ''], + 'NetDnsNs' => ['description' => 'The NS server.'."\n", 'type' => 'string', 'example' => '189.12.32.124', 'title' => ''], + 'NetDigSwitch' => ['description' => 'Indicates whether the data is displayed in the DIG format. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetDnsServer' => ['description' => 'The type of the DNS server. Valid values:'."\n" + ."\n" + .'* 0: ipv4'."\n" + .'* 1: ipv6'."\n" + .'* 2: A version is automatically selected.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NetDnsTimeout' => ['description' => 'The timeout period of DNS requests.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Nav' => [ + 'description' => 'The browser test task.'."\n", + 'type' => 'object', + 'properties' => [ + 'NavDisableCache' => ['description' => 'Indicates whether caching is disabled. Valid values:'."\n" + ."\n" + .'* 1: Caching is disabled.'."\n" + .'* 0: Caching is enabled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NavReturnElement' => ['description' => 'Indicates whether the elements on the page are returned.'."\n" + ."\n" + .'* 1: no. The basic document data is returned.'."\n" + .'* 2: yes. All document data is returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NavRedirect' => ['description' => 'Indicates whether redirection is enabled. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NavDisableCompression' => ['description' => 'Indicates whether compression is disabled. Valid values:'."\n" + ."\n" + .'* 0: Compression is enabled.'."\n" + .'* 1: Compression is disabled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NavAutomaticScrolling' => ['description' => 'Indicates whether the screen is automatically scrolled up and down to load a page. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NavIgnoreCertificateError' => ['description' => 'Indicates whether certificate errors are ignored during certificate verification in the SSL handshake. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'FilterInvalidIP' => ['description' => 'Indicates whether invalid IP addresses are excluded. Valid values:'."\n" + ."\n" + .'* 1: no'."\n" + .'* 0: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExecuteApplet' => ['description' => 'Indicates whether the applet is executed. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExecuteActiveX' => ['description' => 'Indicates whether ActiveX is executed. Valid values:'."\n" + ."\n" + .'* 3: yes'."\n" + .'* 0: no'."\n" + ."\n" + .'> Only IE elements support this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '3', 'title' => ''], + 'ExecuteScript' => ['description' => 'Indicates whether scripts are executed. Valid values:'."\n" + ."\n" + .'* 1: yes'."\n" + .'* 0: no'."\n" + ."\n" + .'> Only IE elements support this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'QuicVersion' => ['description' => 'The QUIC version. Default value: 0. Valid values:'."\n" + ."\n" + .'* 35'."\n" + .'* 39'."\n" + .'* 43'."\n" + .'* 44'."\n" + ."\n" + .'> Only Chrome elements support this parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'QuicDomain' => ['description' => 'The domain name of the QUIC request element.'."\n", 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'RequestHeader' => ['description' => 'Indicates whether request headers are returned. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: The headers of base documents are returned.'."\n" + .'* 2: All headers are returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'NavCustomHost' => ['description' => 'The custom host mode. Valid values:'."\n" + ."\n" + .'* 1: round robin'."\n" + .'* 0: random'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'NavCustomHostIp' => ['description' => 'The custom IP address of the host. Multiple IP addresses are separated with commas (,).'."\n", 'type' => 'string', 'example' => '119.119.53.156/32', 'title' => ''], + 'NavCustomHeader' => ['description' => 'Indicates whether a custom header is created. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: A custom header is created for the first packet.'."\n" + .'* 2: A custom header is created for all packets.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'NavCustomHeaderContent' => ['description' => 'The format of the custom header. Multiple fields are separated with vertical bars (|).'."\n", 'type' => 'string', 'example' => 'content', 'title' => ''], + 'ElementBlacklist' => ['description' => 'The element blacklist.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'ProcessName' => ['description' => 'The process ID.'."\n", 'type' => 'string', 'example' => 'ssh', 'title' => ''], + 'VerifyStringBlacklist' => ['description' => 'The blacklist for string verification.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'VerifyStringWhitelist' => ['description' => 'The whitelist for string verification.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'WaitCompletionTime' => ['description' => 'The timeout period of waiting for the monitoring to complete.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'SlowElementThreshold' => ['description' => 'The time threshold that is used to define a slow element. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'DnsHijackWhitelist' => ['description' => 'The DNS whitelist.'."\n", 'type' => 'string', 'example' => '119.119.53.156', 'title' => ''], + 'PageTampering' => ['description' => 'The page tampering.'."\n", 'type' => 'string', 'example' => 'content', 'title' => ''], + 'FlowHijackJumpTimes' => ['description' => 'The element that is used in DNS hijacking.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'FlowHijackLogo' => ['description' => 'The tag that is used in DNS hijacking.'."\n", 'type' => 'string', 'example' => 'target', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Protocol' => [ + 'description' => 'The synthetic monitoring task of the API performance type.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestContent' => [ + 'description' => 'The request content, including the header and body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => ['description' => 'The request method. Valid values:'."\n" + ."\n" + .'* POST'."\n" + .'* GET'."\n", 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'Header' => [ + 'description' => 'The request header.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The header information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the header in the request parameters.'."\n", 'type' => 'string', 'example' => 'regionId', 'title' => ''], + 'Value' => ['description' => 'The value of the header in the request parameters.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Body' => [ + 'description' => 'The content of the request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Mode' => ['description' => 'The type of the content. Valid values:'."\n" + ."\n" + .'* form-data'."\n" + .'* x-www-form-urlencoded'."\n" + .'* raw'."\n", 'type' => 'string', 'example' => 'form-data', 'title' => ''], + 'Formdata' => [ + 'description' => 'The data content. This parameter is returned when Mode is set to form-data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the **form-data**.'."\n", 'type' => 'string', 'example' => 'appId', 'title' => ''], + 'Value' => ['description' => 'The value of the form-data.'."\n", 'type' => 'string', 'example' => '3425', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Urlencoded' => [ + 'description' => 'The URL of the body content.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'appId', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => '11080', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Raw' => ['description' => 'The data content. This parameter is returned when **Mode** is set to **raw**.'."\n", 'type' => 'string', 'example' => 'content', 'title' => ''], + 'Language' => ['description' => 'The language used when Mode is set to raw. Valid values:'."\n" + ."\n" + .'* json'."\n" + .'* xml'."\n" + .'* javascript'."\n" + .'* html'."\n" + .'* text'."\n", 'type' => 'string', 'example' => 'xml', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], ], - 'Source' => [ + 'title' => '', + 'example' => '', + ], + 'CharacterEncoding' => ['description' => 'The encoding format. Valid values:'."\n" + ."\n" + .'* 0: UTF-8'."\n" + .'* 1: GBK'."\n" + .'* 2: GB2312'."\n" + .'* 3: Unicode'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'VerifyWay' => ['description' => 'The method that is used to verify the response content. Valid values:'."\n" + ."\n" + .'* 0: no verification.'."\n" + .'* 1: exact match with the verification string.'."\n" + .'* 2: partial match with the verification string.'."\n" + .'* 3: MD5 verification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'VerifyContent' => ['description' => 'The verification string.'."\n", 'type' => 'string', 'example' => 'list', 'title' => ''], + 'ReceivedDataSize' => ['description' => 'The size of the received data. This parameter is returned when **VerifyWay** is set to 2.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'ProtocolMonitorTimeout' => ['description' => 'The timeout period of API performance monitoring. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30', 'title' => ''], + 'ProtocolConnectionTimeout' => ['description' => 'The timeout period.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'CustomHost' => ['description' => 'The custom host. Valid values:'."\n" + ."\n" + .'* 1: round robin'."\n" + .'* 0: random'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CustomHostIp' => ['description' => 'The custom IP address of the host. Multiple IP addresses are separated with commas (,).'."\n", 'type' => 'string', 'example' => '119.119.53.156', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'MonitorListString' => ['description' => 'The detection points.'."\n", 'type' => 'string', 'example' => '12', 'title' => ''], + 'CommonParam' => [ + 'description' => 'The list of common parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlarmFlag' => ['description' => 'The identifier of the alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'AlertPolicyId' => ['description' => 'The ID of the alert policy.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'AlertNotifierId' => ['description' => 'The ID of the alert identifier.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'StartExecutionTime' => ['description' => 'The start time of the execution.'."\n", 'type' => 'string', 'example' => '1664427128', 'title' => ''], + 'MonitorSamples' => ['description' => 'The monitoring samples.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'AlertList' => [ + 'description' => 'The list of alerts.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The alert name.'."\n", 'type' => 'string', 'example' => 'alert-test', 'title' => ''], + 'GeneralAlert' => ['description' => 'The low-risk alert.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'SeriousAlert' => ['description' => 'The Critical-level alert.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'IsCritical' => ['description' => 'Indicates whether the condition is essential.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Symbols' => ['description' => 'Greater than or less than.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + ], 'description' => '', - 'type' => 'string', - 'example' => 'arms', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1\\",\\n \\"Data\\": {\\n \\"EnableTag\\": true,\\n \\"Products\\": [\\n {\\n \\"Descr\\": \\"-\\\\n\\",\\n \\"Instance\\": \\"cloudserver\\",\\n \\"Prod\\": \\"face\\",\\n \\"Name\\": \\"hologres\\",\\n \\"Id\\": \\"20210\\",\\n \\"State\\": \\"true\\",\\n \\"Time\\": \\"1647852021000\\",\\n \\"Type\\": \\"HOLOGRES\\",\\n \\"Url\\": \\"https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\\\\\\\u003d9\\\\\\\\u0026refresh\\\\\\\\u003d60s\\",\\n \\"Source\\": \\"arms\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListCmsInstances', - ], - 'ListDashboardsByName' => [ - 'summary' => 'Uses Loki data sources and other data sources to create a Grafana dashboard in Managed Service for Prometheus.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"TaskDetail\\": {\\n \\"TaskId\\": 19584,\\n \\"TaskName\\": \\"net-test\\",\\n \\"Url\\": \\"www.example.com\\",\\n \\"MonitorList\\": [\\n {\\n \\"CityCode\\": 0,\\n \\"NetServiceId\\": 12,\\n \\"MonitorType\\": 1,\\n \\"SendCount\\": 2\\n }\\n ],\\n \\"TaskType\\": 0,\\n \\"IntervalTime\\": 20,\\n \\"IntervalType\\": 0,\\n \\"ExtendInterval\\": {\\n \\"StartTime\\": \\"2022-02-26 11:40\\",\\n \\"EndTime\\": \\"2022-05-03 11:40\\",\\n \\"Days\\": [\\n 3\\n ],\\n \\"StartHour\\": 9,\\n \\"StartMinute\\": 20,\\n \\"Endhour\\": 12,\\n \\"EndMinute\\": 20\\n },\\n \\"IpType\\": 0,\\n \\"Download\\": {\\n \\"DownloadTransmissionSize\\": 20,\\n \\"DownloadCustomHost\\": 0,\\n \\"DownloadCustomHostIp\\": \\"168.23.45.1\\",\\n \\"WhiteList\\": \\"[{\\\\\\\\\\\\\\"src\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"211.154.166.174\\\\\\\\\\\\\\"}]\\",\\n \\"DownloadKernel\\": 1,\\n \\"QuickProtocol\\": \\"1\\",\\n \\"MonitorTimeout\\": 12,\\n \\"ConnectionTimeout\\": 200,\\n \\"VerifyWay\\": 0,\\n \\"ValidateKeywords\\": \\"test\\",\\n \\"DownloadRedirect\\": 1,\\n \\"DownloadCustomHeaderContent\\": \\"char\\"\\n },\\n \\"Net\\": {\\n \\"NetIcmpSwitch\\": 0,\\n \\"NetIcmpActive\\": 0,\\n \\"NetIcmpTimeout\\": 20,\\n \\"NetIcmpInterval\\": 10,\\n \\"NetIcmpNum\\": 10,\\n \\"NetIcmpSize\\": 30,\\n \\"NetIcmpDataCut\\": 0,\\n \\"NetDnsQueryMethod\\": \\"1\\",\\n \\"NetDnsSwitch\\": 0,\\n \\"NetTraceRouteSwitch\\": 0,\\n \\"NetTraceRouteTimeout\\": 20,\\n \\"NetTraceRouteNum\\": 30,\\n \\"WhiteList\\": \\"119.119.53.156/32\\",\\n \\"NetDnsNs\\": \\"189.12.32.124\\",\\n \\"NetDigSwitch\\": 0,\\n \\"NetDnsServer\\": 0,\\n \\"NetDnsTimeout\\": \\"10\\"\\n },\\n \\"Nav\\": {\\n \\"NavDisableCache\\": 1,\\n \\"NavReturnElement\\": 1,\\n \\"NavRedirect\\": 1,\\n \\"NavDisableCompression\\": 0,\\n \\"NavAutomaticScrolling\\": 1,\\n \\"NavIgnoreCertificateError\\": 1,\\n \\"FilterInvalidIP\\": 1,\\n \\"ExecuteApplet\\": 1,\\n \\"ExecuteActiveX\\": 3,\\n \\"ExecuteScript\\": 1,\\n \\"QuicVersion\\": 0,\\n \\"QuicDomain\\": \\"www.example.com\\",\\n \\"RequestHeader\\": 0,\\n \\"NavCustomHost\\": 1,\\n \\"NavCustomHostIp\\": \\"119.119.53.156/32\\",\\n \\"NavCustomHeader\\": \\"0\\",\\n \\"NavCustomHeaderContent\\": \\"content\\",\\n \\"ElementBlacklist\\": \\"test\\",\\n \\"ProcessName\\": \\"ssh\\",\\n \\"VerifyStringBlacklist\\": \\"test\\",\\n \\"VerifyStringWhitelist\\": \\"test\\",\\n \\"MonitorTimeout\\": 20,\\n \\"WaitCompletionTime\\": 20,\\n \\"SlowElementThreshold\\": 30,\\n \\"DnsHijackWhitelist\\": \\"119.119.53.156\\",\\n \\"PageTampering\\": \\"content\\",\\n \\"FlowHijackJumpTimes\\": 12,\\n \\"FlowHijackLogo\\": \\"target\\"\\n },\\n \\"Protocol\\": {\\n \\"RequestContent\\": {\\n \\"Method\\": \\"POST\\",\\n \\"Header\\": [\\n {\\n \\"Key\\": \\"regionId\\",\\n \\"Value\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"Body\\": {\\n \\"Mode\\": \\"form-data\\",\\n \\"Formdata\\": {\\n \\"Key\\": \\"appId\\",\\n \\"Value\\": \\"3425\\"\\n },\\n \\"Urlencoded\\": {\\n \\"Key\\": \\"appId\\",\\n \\"Value\\": \\"11080\\"\\n },\\n \\"Raw\\": \\"content\\",\\n \\"Language\\": \\"xml\\"\\n }\\n },\\n \\"CharacterEncoding\\": 0,\\n \\"VerifyWay\\": 0,\\n \\"VerifyContent\\": \\"list\\",\\n \\"ReceivedDataSize\\": 30,\\n \\"ProtocolMonitorTimeout\\": 30,\\n \\"ProtocolConnectionTimeout\\": 20,\\n \\"CustomHost\\": 1,\\n \\"CustomHostIp\\": \\"119.119.53.156\\"\\n },\\n \\"MonitorListString\\": \\"12\\",\\n \\"CommonParam\\": {\\n \\"AlarmFlag\\": 1,\\n \\"AlertPolicyId\\": \\"1\\",\\n \\"AlertNotifierId\\": \\"1\\",\\n \\"StartExecutionTime\\": \\"1664427128\\",\\n \\"MonitorSamples\\": \\"1\\",\\n \\"AlertList\\": [\\n {\\n \\"Name\\": \\"alert-test\\",\\n \\"GeneralAlert\\": \\"1\\",\\n \\"SeriousAlert\\": \\"1\\",\\n \\"IsCritical\\": \\"0\\",\\n \\"Symbols\\": \\"1\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', + 'title' => 'GetSyntheticTaskDetail', + 'changeSet' => [ + ['createdAt' => '2023-12-06T09:06:44.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-22T07:28:42.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticTaskDetail'], + ], ], + 'ramActions' => [], + ], + 'GetSyntheticTaskList' => [ + 'summary' => 'Queries a list of scheduled synthetic monitoring tasks.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Default value: **cn-hangzhou**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'TaskType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster. If the ClusterType parameter is not set to `cloud-product-prometheus` or `cms-enterprise-prometheus`, you must specify the ClusterId parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'1. 3: web page performance - IE'."\n" + .'2. 34: web page performance - Chrome'."\n" + .'3. 0: network quality'."\n" + .'4. 40: file download'."\n" + .'5. 7: API performance'."\n", 'type' => 'string', 'required' => false, 'example' => '0', 'title' => ''], ], [ - 'name' => 'DataSourceType', + 'name' => 'Url', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the data source. Valid values:'."\n" - ."\n" - .'* loki'."\n" - .'* prometheus'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'loki', - ], + 'schema' => ['description' => 'The URL for synthetic monitoring.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://www.example.com'."\n", 'title' => ''], ], [ - 'name' => 'ClusterType', + 'name' => 'TaskName', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster type. Valid values:'."\n" - ."\n" - .'* vpc-prometheus'."\n" - .'* cloud-product-prometheus'."\n" - .'* cms-enterprise-prometheus'."\n" - .'* ExternalKubernetes'."\n" - .'* Ask'."\n" - .'* Kubernetes'."\n" - .'* ManagedKubernetes'."\n" - .'* remote-write-prometheus'."\n" - .'* GlobalViewV2'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cloud-product-prometheus', - ], + 'schema' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'net-test', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'TaskStatus', 'in' => 'query', - 'schema' => [ - 'description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'edas', - ], + 'schema' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* **0**: The task is stopped.'."\n" + .'* **1**: The task is started.'."\n" + .'* **9**: The task is ended.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'PageNum', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dashboard group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EDAS', - ], + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'DashBoardName', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'edas-ingress-url', - ], + 'schema' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'DashBoardVersion', + 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => 'The version of the dashboard.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'latest', - ], + 'schema' => ['description' => 'The condition by which the queried tasks are sorted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CreateTime', 'title' => ''], ], [ - 'name' => 'OnlyQuery', + 'name' => 'Direction', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to display the Grafana dashboard only in the Application Real-Time Monitoring Service (ARMS) console.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The order by which the queried tasks are sorted. Valid values:'."\n" + ."\n" + .'* **asc**: ascending'."\n" + .'* **desc**: descending'."\n", 'type' => 'string', 'required' => false, 'example' => 'asc', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The response parameters.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'string', - 'example' => '[{"name":"Edas Ingress Url Analysis","type":"edas-ingress-url-analysis","url":"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou"}]', - ], - 'RequestId' => [ - 'description' => 'The ID of the request, You can use the ID to locate logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', - ], - 'Code' => [ - 'description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'PageInfo' => [ + 'description' => 'The query results.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'List' => [ + 'description' => 'The task information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of the scheduled task.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'example' => '2118709', 'title' => ''], + 'TaskName' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => 'net-test', 'title' => ''], + 'Url' => ['description' => 'The URL for synthetic monitoring.'."\n", 'type' => 'string', 'example' => 'www.example.com', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'1. 3: web page performance - IE'."\n" + .'2. 34: web page performance - Chrome'."\n" + .'3. 0: network quality'."\n" + .'4. 40: file download'."\n" + .'5. 7: API performance'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'TaskTypeName' => ['description' => 'The name of the task type.'."\n", 'type' => 'string', 'example' => '网络质量', 'title' => ''], + 'MonitorNumber' => ['description' => 'The number of detection points.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'TaskStatus' => ['description' => 'The status of the task. Valid values:'."\n" + ."\n" + .'* **0**: The task is stopped.'."\n" + .'* **1**: The task is started.'."\n" + .'* **9**: The task is ended.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'Usable' => ['description' => 'The availability. Only the data of the last day is counted. If no data is available for the last day, an empty value is returned.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '0.80', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.'."\n", 'type' => 'string', 'example' => '1634005438000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Size' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], + 'Pages' => ['description' => 'The total number of pages returned.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'Prepage' => ['description' => 'The previous page.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'NextPage' => ['description' => 'The next page.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], + 'IsFirstPage' => ['description' => 'Indicates whether the page is the first page.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'IsLastPage' => ['description' => 'Indicates whether the page is the last page.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HasPreviousPage' => ['description' => 'Indicates whether a previous page exists.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'HasNextPage' => ['description' => 'Indicates whether the current page is followed by a page.'."\n", 'type' => 'string', 'example' => 'false', 'title' => ''], + 'NavigatePageNums' => ['description' => 'All navigation page numbers.'."\n", 'type' => 'string', 'example' => '1,2,3', 'title' => ''], + 'NavigateFirstPage' => ['description' => 'The first page on the navigation bar.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'NavigateLastPage' => ['description' => 'The last page on the navigation bar.'."\n", 'type' => 'string', 'example' => '3', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"Edas Ingress Url Analysis\\\\\\",\\\\\\"type\\\\\\":\\\\\\"edas-ingress-url-analysis\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou\\\\\\"}]\\",\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDashboardsByNameResponse>\\n <Data>[{\\"name\\":\\"Edas Ingress Url Analysis\\",\\"type\\":\\"edas-ingress-url-analysis\\",\\"url\\":\\"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou\\"}]</Data>\\n <RequestId>2983BEF7-4A0D-47A2-94A2-8E9C5E63****</RequestId>\\n</ListDashboardsByNameResponse>","errorExample":""}]', - 'title' => 'ListDashboardsByName', - ], - 'GetAuthToken' => [ - 'summary' => 'Obtains an authentication token. When you connect a Container Service for Kubernetes (ACK) cluster to Prometheus Service over the Internet, you must use a token for authentication.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"PageInfo\\": {\\n \\"Total\\": 15,\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"2118709\\",\\n \\"TaskName\\": \\"net-test\\",\\n \\"Url\\": \\"www.example.com\\",\\n \\"TaskType\\": 0,\\n \\"TaskTypeName\\": \\"网络质量\\",\\n \\"MonitorNumber\\": 2,\\n \\"TaskStatus\\": \\"0\\",\\n \\"Usable\\": 0.8,\\n \\"CreateTime\\": \\"1634005438000\\"\\n }\\n ],\\n \\"Size\\": 10,\\n \\"Pages\\": \\"10\\",\\n \\"Prepage\\": \\"1\\",\\n \\"NextPage\\": \\"3\\",\\n \\"IsFirstPage\\": true,\\n \\"IsLastPage\\": true,\\n \\"HasPreviousPage\\": true,\\n \\"HasNextPage\\": \\"false\\",\\n \\"NavigatePageNums\\": \\"1,2,3\\",\\n \\"NavigateFirstPage\\": \\"1\\",\\n \\"NavigateLastPage\\": \\"3\\"\\n }\\n}","type":"json"}]', + 'title' => 'GetSyntheticTaskList', + 'changeSet' => [ + ['createdAt' => '2022-08-25T11:32:27.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticTaskList'], + ], ], + ], + 'GetSyntheticTaskMonitors' => [ + 'summary' => 'Obtains the information about synthetic monitoring points.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the ACK cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region in which the application is located.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****'], + 'Code' => ['description' => 'The status code returned.'."\n" + ."\n" + .'* 1001: The request was successful.'."\n" + .'* 1002: The request failed.'."\n" + .'* 1003: Parameter errors occurred.'."\n" + .'* 1004: Authentication failed.'."\n" + .'* 1006: The task does not exist.'."\n" + .'* 1099: Internal errors occurred.'."\n", 'type' => 'string', 'example' => '1001', 'title' => ''], + 'Msg' => ['description' => 'The message that is returned when the request failed.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], 'Data' => [ - 'description' => 'The returned authentication token.'."\n", - 'type' => 'string', - 'example' => 'eyJhbGciOiJIUzI1NiJ9******', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'Additional Information.', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Whether the query was successful:'."\n" - .'- true: Success'."\n" - .'- false: Failure', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The details of the monitoring point.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClientType' => ['description' => 'The client type:'."\n" + ."\n" + .'* 1: IDC'."\n" + .'* 2: Last mile'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'CityCode' => ['description' => 'The ID of the city to which the monitoring point belongs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1100101', 'title' => ''], + 'City' => ['description' => 'The name of the city to which the monitoring point belongs.'."\n", 'type' => 'string', 'example' => '北京市', 'title' => ''], + 'District' => ['description' => 'The region to which the monitoring point belongs.'."\n", 'type' => 'string', 'example' => '北京', 'title' => ''], + 'NetServiceId' => ['description' => 'The ID of the carrier.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '18', 'title' => ''], + 'NetServiceName' => ['description' => 'The name of the carrier.'."\n", 'type' => 'string', 'example' => 'XXX', 'title' => ''], + 'Busy' => ['description' => 'The task status.'."\n" + ."\n" + .'* 0: active'."\n" + .'* 1: busy'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"eyJhbGciOiJIUzI1NiJ9******\\",\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<GetAuthTokenResponse>\\n <Data>success</Data>\\n <RequestId>1A9C645C-C83F-4C9D-8CCB-29BEC9E1****</RequestId>\\n</GetAuthTokenResponse>","errorExample":""}]', - 'title' => 'GetAuthToken', - ], - 'GetClusterAllUrl' => [ - 'summary' => 'Obtains all the URLs of a cluster, including remote read and write URLs, Pushgateway URLs, and Grafana URLs.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": \\"1001\\",\\n \\"Msg\\": \\"null\\",\\n \\"Data\\": [\\n {\\n \\"ClientType\\": 1,\\n \\"CityCode\\": 1100101,\\n \\"City\\": \\"北京市\\",\\n \\"District\\": \\"北京\\",\\n \\"NetServiceId\\": 18,\\n \\"NetServiceName\\": \\"XXX\\",\\n \\"Busy\\": 0\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'GetSyntheticTaskMonitors', + 'changeSet' => [ + ['createdAt' => '2022-07-26T12:41:04.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticTaskMonitors'], + ], ], + 'ramActions' => [], + ], + 'GetTimingSyntheticTask' => [ + 'summary' => 'Obtains the details of a synthetic monitoring task.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'required' => false, 'example' => '856566a9cb2a4cafa05aa95ed0*******', 'title' => ''], ], ], 'responses' => [ @@ -22026,218 +16581,639 @@ 'schema' => [ 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'E13430A6-57A9-56E9-9D8D-28FE8DEBCA40'], + 'Code' => ['description' => 'The status code returned. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => 'The response parameters in the JSON format.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "RequestId": "41877338-646B-5DD6-BFBE-F89F1E7245AD",'."\n" - .' "Data": "{\\"clusterType\\":\\"ManagedKubernetes\\",\\"remoteWriteUrl\\":\\"http:/" }', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The prompt information of the returned result.', - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Whether the query is successful:'."\n" - .'- true: success'."\n" - .'- false: failure', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Name' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'example' => '拨测任务', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" + ."\n" + .'ICMP TCP DNS HTTP Website speed measurement File download'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'MonitorConf' => [ + 'description' => 'The monitoring configurations.'."\n", + 'type' => 'object', + 'properties' => [ + 'NetICMP' => [ + 'description' => 'The ICMP synthetic test parameters. This parameter is required if the TaskType parameter is set to 1.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => 'The destination host IP address or domain name'."\n", + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'www.aliyun.com', + 'title' => '', + ], + 'Interval' => ['description' => 'The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 2000. Default value: 200.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'PackageNum' => ['description' => 'The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'PackageSize' => ['description' => 'The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1024', 'title' => ''], + 'SplitPackage' => ['description' => 'Specifies whether to split ICMP packets. Default value: true.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2000', 'title' => ''], + 'TracertEnable' => ['description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TracertNumMax' => ['description' => 'The maximum number of hops for tracert. Minimum value: 1. Maximum value: 128. Default value: 64.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '64', 'title' => ''], + 'TracertTimeout' => ['description' => 'The timeout period of tracert. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NetTCP' => [ + 'description' => 'The TCP synthetic tests parameters. This parameter is required if the TaskType parameter is set to 2.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The destination host IP address.'."\n", 'type' => 'string', 'example' => '127.0.0.1:8888', 'title' => ''], + 'ConnectTimes' => ['description' => 'The number of TCP connections that are established in a test. Minimum value: 1. Maximum value: 16. Default value: 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Interval' => ['description' => 'The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20000', 'title' => ''], + 'TracertEnable' => ['description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TracertNumMax' => ['description' => 'The maximum number of hops for tracert. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TracertTimeout' => ['description' => 'The timeout period of tracert. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '60000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'NetDNS' => [ + 'description' => 'The DNS synthetic test parameters. This parameter is required if the TaskType parameter is set to 3.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The destination domain name.'."\n", 'type' => 'string', 'example' => 'www.aliyun.com', 'title' => ''], + 'DnsServerIpType' => ['description' => 'The IP version of the DNS server. 0: IPv4. 1: IPv6. 2: A version is automatically selected. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'NsServer' => ['description' => 'The IP address of the DNS server. Default value: 114.114.114.114.'."\n", 'type' => 'string', 'example' => '114.114.114.114', 'title' => ''], + 'QueryMethod' => ['description' => 'The DNS query. 0: recursive, 1: iterative. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for the DNS synthetic test. Unit: milliseconds. The minimum value is 1000 and the maximum value is 45000. Default value: 5000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ApiHTTP' => [ + 'description' => 'The parameters of the HTTP(S) synthetic test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The URL for synthetic monitoring.'."\n", 'type' => 'string', 'example' => 'http://127.0.0.1:8090/api/list', 'title' => ''], + 'Method' => ['description' => 'The request method.'."\n" + ."\n" + .'* POST'."\n" + .'* GET'."\n", 'type' => 'string', 'example' => 'POST', 'title' => ''], + 'RequestHeaders' => [ + 'description' => 'The HTTP request header.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'Format: JSON map.'."\n", 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'RequestBody' => [ + 'description' => 'The HTTP request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The content of the request body. Format: JSON string. The parameter is required if the type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.'."\n", 'type' => 'string', 'example' => 'text/plain', 'title' => ''], + 'Type' => ['description' => 'The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.'."\n", 'type' => 'string', 'example' => 'multipart/form-data', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'ConnectTimeout' => ['description' => 'The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10000', 'title' => ''], + 'CheckCert' => ['description' => 'Whether to verify the certificate. The default is no.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ProtocolAlpnProtocol' => ['description' => 'The ALPN protocol version. You can configure this parameter when you perform an HTTPS synthetic test on a WAP mobile client. Valid values:'."\n" + ."\n" + .'0: default'."\n" + ."\n" + .'1: HTTP/1.1'."\n" + ."\n" + .'2: HTTP/2'."\n" + ."\n" + .'3: disables the ALPN protocol'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'FileDownload' => [ + 'description' => 'The file download parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The file download URL.'."\n", 'type' => 'string', 'example' => 'https://********', 'title' => ''], + 'DownloadKernel' => ['description' => 'The kernel type.'."\n" + ."\n" + .'* 1: curl'."\n" + .'* 0: WinInet'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0', 'title' => ''], + 'QuickProtocol' => ['description' => 'The QUIC protocol type.'."\n" + ."\n" + .'* 1: http1'."\n" + .'* 2: http2'."\n" + .'* 3: http3'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ConnectionTimeout' => ['description' => 'The connection timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The content of the custom request header.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'description' => 'Format: JSON map.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'IgnoreCertificateStatusError' => ['description' => 'Specifies whether to ignore certificate status errors. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IgnoreCertificateUntrustworthyError' => ['description' => 'Specifies whether to ignore certificate incredibility. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IgnoreInvalidHostError' => ['description' => 'Specifies whether to ignore host invalidity. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6000', 'title' => ''], + 'Redirection' => ['description' => 'Specifies whether to support redirection. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'TransmissionSize' => ['description' => 'The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2048', 'title' => ''], + 'IgnoreCertificateCanceledError' => ['description' => 'Specifies whether to ignore certificate revocation errors. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IgnoreCertificateAuthError' => ['description' => 'Specifies whether to ignore CA certificate authentication errors. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IgnoreCertificateOutOfDateError' => ['description' => 'Specifies whether to ignore certificate invalidity. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IgnoreCertificateUsingError' => ['description' => 'Specifies whether to ignore certificate usage errors. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'VerifyWay' => ['description' => 'Verification method.'."\n" + ."\n" + .'- 0: No verification'."\n" + .'- 1: Verification string'."\n" + .'- 2: MD5 verification', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'ValidateKeywords' => ['description' => 'Verify keywords.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'WhiteList' => ['description' => 'DNS hijacking whitelist. Matching rules support IP, IP wildcard, subnet mask and CNAME. You can fill in multiple matching rules, and multiple matching rules are separated by vertical bars (|). For example: `www.aliyun.com:203.0.3.55|203.3.44.67`, which means that all IPs except 203.0.3.55 and 203.3.44.67 under the www.aliyun.com domain name are hijacked.', 'type' => 'string', 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Website' => [ + 'description' => 'The website-speed measurement parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The destination URL.'."\n", 'type' => 'string', 'example' => 'http://www.aliyun.com', 'title' => ''], + 'AutomaticScrolling' => ['description' => 'Specifies whether to automatically scroll up and down the screen to load a page. 0: No. 1: Yes. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CustomHeader' => ['description' => 'Specifies whether to create a custom header. 0: No. 1: The first packet is modified. 2: All packets are modified. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The custom header. Format: JSON map.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}'."\n", 'description' => 'JSON Map'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'DisableCache' => ['description' => 'Specifies whether to disable the cache. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'."\n", 'title' => ''], + 'DisableCompression' => ['description' => 'Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. 0: No. 1: Yes. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'FilterInvalidIP' => ['description' => 'Specifies whether to exclude invalid IP addresses.'."\n" + ."\n" + .'* 1: No'."\n" + .'* 0: Yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IgnoreCertificateError' => ['description' => 'Specifies whether to ignore SSL certificate errors during browsing. 0: No. 1: Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period. Unit: milliseconds. Default value: 20000. Minimum value: 5000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20000', 'title' => ''], + 'Redirection' => ['description' => 'Specifies whether to continue browsing after redirection. 0: No, 1:Yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'SlowElementThreshold' => ['description' => 'The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], + 'WaitCompletionTime' => ['description' => 'The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5000', 'title' => ''], + 'VerifyStringBlacklist' => ['description' => 'The verification string is an arbitrary string in the source code of the monitoring page. If the source code returned by the client contains any string in the blacklist, an error 650 "Verification string failed" will be reported. Multiple strings are separated by vertical bars (|).', 'type' => 'string', 'example' => 'error', 'title' => ''], + 'VerifyStringWhitelist' => ['description' => 'The verification string is an arbitrary string in the source code of the monitoring page. The source code returned by the client must contain all the strings in the whitelist, otherwise an error 650 "Verification string failed" will be reported. Multiple strings are separated by a vertical bar (|).', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'ElementBlacklist' => ['description' => 'If an element configured in the element blacklist appears during page loading, no request will be made to load the element.', 'type' => 'string', 'example' => 'www.example.com/a.jpg', 'title' => ''], + 'DNSHijackWhitelist' => ['description' => 'When resolving a domain name (such as www.aliyun.com), if the resolved IP address or CNAME is not in the DNS hijacking whitelist, the user will fail to access or return a non-Aliyun target IP; if the IP or CNAME in the resolution result is in the DNS whitelist, it will be deemed that no DNS hijacking has occurred.'."\n" + ."\n" + .'Fill in the format: `domain name: matching rule`. Matching rules support IP, IP wildcard, subnet mask and CNAME. You can fill in multiple matching rules, and multiple matching rules are separated by vertical bars (|). '."\n" + ."\n" + .'For example: `www.aliyun.com:203.0.3.55|203.3.44.67`, which means that all IPs except 203.0.3.55 and 203.3.44.67 under the www.aliyun.com domain name are hijacked.', 'type' => 'string', 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + 'PageTamper' => ['description' => 'If any element other than the domain name setting appears on the monitoring page, it means that the page has been tampered. Common manifestations include pop-up ads, floating ads, jumps, etc.'."\n" + ."\n" + .'Fill in the format: `domain name: element`. Elements support wildcards, and multiple elements can be filled in. Multiple elements are separated by vertical bars (|). For example: `www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg`, which means that all elements except the basic document, /cc/bb/a.gif and /vv/bb/cc.jpg under the www.aliyun.com domain name are considered to be tampered with.', 'type' => 'string', 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', 'title' => ''], + 'FlowHijackJumpTimes' => ['description' => 'Identify elements: Set the total number of elements to browse the page.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'FlowHijackLogo' => ['description' => 'Hijacking flag: Set the key information for matching. Fill in the hijacking judgment keyword or key element, and asterisks (*) are allowed.', 'type' => 'string', 'example' => 'aliyun', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Stream' => [ + 'description' => 'Streaming media dial test configuration.', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'Streaming media resource address.', 'type' => 'string', 'example' => 'http://www.aliyun.com/stream/test.mp4', 'title' => ''], + 'StreamType' => ['description' => 'Audio and video flag:'."\n" + ."\n" + .'- 0: video'."\n" + .'- 1: audio', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'StreamMonitorTimeout' => ['description' => 'Monitoring duration, in seconds, supports up to 60 seconds. If not specified, the default value is 60 seconds.', 'type' => 'integer', 'format' => 'int32', 'example' => '30', 'title' => ''], + 'StreamAddressType' => ['description' => 'Resource address type:'."\n" + ."\n" + .'- 1: Resource address.'."\n" + .'- 0: Page address. If not passed, the default value is 0.', 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'PlayerType' => ['description' => 'Player, default is 12 if not specified.'."\n" + ."\n" + .'- 12: VLC'."\n" + .'- 2: Flash Player', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'Custom header, JSON Map format.', + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'Custom header, JSON Map format.', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'WhiteList' => ['description' => 'DNS hijacking whitelist. Matching rules support IP, IP wildcard, subnet mask and CNAME. You can fill in multiple matching rules, and multiple matching rules are separated by vertical bars (|). For example: `www.aliyun.com:203.0.3.55|203.3.44.67`, which means that all IPs except 203.0.3.55 and 203.3.44.67 under the www.aliyun.com domain name are hijacked.', 'type' => 'string', 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'MonitorCategory' => ['description' => 'The detection point type. 1: PC. 2: mobile device.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Monitors' => [ + 'description' => 'The list of monitoring points.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of monitoring points.', + 'type' => 'object', + 'properties' => [ + 'CityCode' => ['description' => 'The city code.'."\n", 'type' => 'string', 'example' => '110100', 'title' => ''], + 'OperatorCode' => ['description' => 'The carrier code.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'ClientType' => ['description' => 'The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Frequency' => ['description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.'."\n", 'type' => 'string', 'example' => '5m', 'title' => ''], + 'CustomPeriod' => [ + 'description' => 'The custom cycle.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndHour' => ['description' => 'The hour at which the test ends. Valid values: 0 to 24.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '22', 'title' => ''], + 'StartHour' => ['description' => 'The hour at which the test starts. Valid values: 0 to 24.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '14', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CommonSetting' => [ + 'description' => 'The general settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => 'The custom host.'."\n", + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'The list of hosts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of hosts.', + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'example' => 'www.aliyun.com', 'title' => ''], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4'."\n" + .'* 2: IPv6'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Ips' => [ + 'description' => 'The list of IP addresses.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '10.0.114.17', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SelectType' => ['description' => 'The selection mode. 0: Random. 1: Polling.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4'."\n" + .'* 2: IPv6'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MonitorSamples' => ['description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" + ."\n" + .'* 0: No'."\n" + .'* 1: Yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsOpenTrace' => ['description' => 'Whether to enable tracing.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TraceClientType' => ['description' => 'Tracing client type:'."\n" + ."\n" + .'- 0: ARMS Agent'."\n" + .'- 1: Open Telemetry'."\n" + .'- 2: Jaeger', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'XtraceRegion' => ['description' => 'Tracing data reporting region.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'CustomVPCSetting' => [ + 'description' => 'User VPC information. If the dial-up is to the Alibaba Cloud intranet address, you need to configure the VPC information.', + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'VpcId' => ['description' => 'VPC ID.', 'type' => 'string', 'example' => 'vpc-2zexy5nae9q2otaxxxx', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp1i0xezblf1yrz4xxxxx', 'title' => ''], + 'SecureGroupId' => ['description' => 'Security group ID. This security group is where the dial-up client is located. The security group limits the inbound and outbound rules of the dial-up client in the VPC. You need to set the inbound rules of the security group where your VPC is located to allow the security group where the dial-up client is located to access. Otherwise, the dial-up client cannot smoothly access the resources in your VPC.', 'type' => 'string', 'example' => 'sg-xxxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CustomPrometheusSetting' => [ + 'description' => 'The reserved parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => 'A reserved parameter.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '保留字段。', 'description' => 'A reserved parameter.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PrometheusClusterId' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'example' => '保留字段。', 'title' => ''], + 'PrometheusClusterRegion' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'example' => '保留字段。', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'AvailableAssertions' => [ + 'description' => 'The list of assertions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.'."\n", 'type' => 'string', 'example' => 'websiteTTLB', 'title' => ''], + 'Target' => ['description' => 'The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.'."\n", 'type' => 'string', 'example' => 'key'."\n", 'title' => ''], + 'Operator' => ['description' => 'The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.'."\n", 'type' => 'string', 'example' => 'gt', 'title' => ''], + 'Expect' => ['description' => 'The expected value.'."\n", 'type' => 'string', 'example' => '100', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Status' => ['description' => 'CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota insufficiency. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: The task failed to be deleted.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'Tags' => [ + 'description' => 'The tag.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'user1', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'p_运维', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::GetPrometheusInstance', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E13430A6-57A9-56E9-9D8D-28FE8DEBCA40\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"5308a2691f59422c8c3b7aeccec9cd3b\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"拨测任务\\",\\n \\"TaskType\\": 5,\\n \\"MonitorConf\\": {\\n \\"NetICMP\\": {\\n \\"TargetUrl\\": \\"www.aliyun.com\\",\\n \\"Interval\\": 200,\\n \\"PackageNum\\": 4,\\n \\"PackageSize\\": 1024,\\n \\"SplitPackage\\": true,\\n \\"Timeout\\": 2000,\\n \\"TracertEnable\\": true,\\n \\"TracertNumMax\\": 64,\\n \\"TracertTimeout\\": 60000\\n },\\n \\"NetTCP\\": {\\n \\"TargetUrl\\": \\"127.0.0.1:8888\\",\\n \\"ConnectTimes\\": 4,\\n \\"Interval\\": 200,\\n \\"Timeout\\": 20000,\\n \\"TracertEnable\\": true,\\n \\"TracertNumMax\\": 20,\\n \\"TracertTimeout\\": 60000\\n },\\n \\"NetDNS\\": {\\n \\"TargetUrl\\": \\"www.aliyun.com\\",\\n \\"DnsServerIpType\\": 0,\\n \\"NsServer\\": \\"114.114.114.114\\",\\n \\"QueryMethod\\": 0,\\n \\"Timeout\\": 5000\\n },\\n \\"ApiHTTP\\": {\\n \\"TargetUrl\\": \\"http://127.0.0.1:8090/api/list\\",\\n \\"Method\\": \\"POST\\",\\n \\"RequestHeaders\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"RequestBody\\": {\\n \\"Content\\": \\"text/plain\\",\\n \\"Type\\": \\"multipart/form-data\\"\\n },\\n \\"ConnectTimeout\\": 5000,\\n \\"Timeout\\": 10000,\\n \\"CheckCert\\": false,\\n \\"ProtocolAlpnProtocol\\": 1\\n },\\n \\"FileDownload\\": {\\n \\"TargetUrl\\": \\"https://********\\",\\n \\"DownloadKernel\\": 0,\\n \\"QuickProtocol\\": 1,\\n \\"ConnectionTimeout\\": 5000,\\n \\"CustomHeaderContent\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"IgnoreCertificateStatusError\\": 0,\\n \\"IgnoreCertificateUntrustworthyError\\": 0,\\n \\"IgnoreInvalidHostError\\": 0,\\n \\"MonitorTimeout\\": 6000,\\n \\"Redirection\\": 0,\\n \\"TransmissionSize\\": 2048,\\n \\"IgnoreCertificateCanceledError\\": 0,\\n \\"IgnoreCertificateAuthError\\": 0,\\n \\"IgnoreCertificateOutOfDateError\\": 0,\\n \\"IgnoreCertificateUsingError\\": 0,\\n \\"VerifyWay\\": 0,\\n \\"ValidateKeywords\\": \\"success\\",\\n \\"WhiteList\\": \\"www.aliyun.com:203.0.3.55|203.3.44.67\\"\\n },\\n \\"Website\\": {\\n \\"TargetUrl\\": \\"http://www.aliyun.com\\",\\n \\"AutomaticScrolling\\": 0,\\n \\"CustomHeader\\": 0,\\n \\"CustomHeaderContent\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"DisableCache\\": 1,\\n \\"DisableCompression\\": 0,\\n \\"FilterInvalidIP\\": 0,\\n \\"IgnoreCertificateError\\": 0,\\n \\"MonitorTimeout\\": 20000,\\n \\"Redirection\\": 1,\\n \\"SlowElementThreshold\\": 5000,\\n \\"WaitCompletionTime\\": 5000,\\n \\"VerifyStringBlacklist\\": \\"error\\",\\n \\"VerifyStringWhitelist\\": \\"success\\",\\n \\"ElementBlacklist\\": \\"www.example.com/a.jpg\\",\\n \\"DNSHijackWhitelist\\": \\"www.aliyun.com:203.0.3.55|203.3.44.67\\",\\n \\"PageTamper\\": \\"www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg\\",\\n \\"FlowHijackJumpTimes\\": 0,\\n \\"FlowHijackLogo\\": \\"aliyun\\"\\n },\\n \\"Stream\\": {\\n \\"TargetUrl\\": \\"http://www.aliyun.com/stream/test.mp4\\",\\n \\"StreamType\\": 0,\\n \\"StreamMonitorTimeout\\": 30,\\n \\"StreamAddressType\\": 0,\\n \\"PlayerType\\": 12,\\n \\"CustomHeaderContent\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"WhiteList\\": \\"www.aliyun.com:203.0.3.55|203.3.44.67\\"\\n }\\n },\\n \\"MonitorCategory\\": 1,\\n \\"Monitors\\": [\\n {\\n \\"CityCode\\": \\"110100\\",\\n \\"OperatorCode\\": \\"1\\",\\n \\"ClientType\\": 1\\n }\\n ],\\n \\"Frequency\\": \\"5m\\",\\n \\"CustomPeriod\\": {\\n \\"EndHour\\": 22,\\n \\"StartHour\\": 14\\n },\\n \\"CommonSetting\\": {\\n \\"CustomHost\\": {\\n \\"Hosts\\": [\\n {\\n \\"Domain\\": \\"www.aliyun.com\\",\\n \\"IpType\\": 0,\\n \\"Ips\\": [\\n \\"10.0.114.17\\"\\n ]\\n }\\n ],\\n \\"SelectType\\": 0\\n },\\n \\"IpType\\": 0,\\n \\"MonitorSamples\\": 0,\\n \\"IsOpenTrace\\": true,\\n \\"TraceClientType\\": 1,\\n \\"XtraceRegion\\": \\"cn-hangzhou\\",\\n \\"CustomVPCSetting\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-2zexy5nae9q2otaxxxx\\",\\n \\"VSwitchId\\": \\"vsw-bp1i0xezblf1yrz4xxxxx\\",\\n \\"SecureGroupId\\": \\"sg-xxxxxxx\\"\\n },\\n \\"CustomPrometheusSetting\\": {\\n \\"PrometheusLabels\\": {\\n \\"key\\": \\"保留字段。\\"\\n },\\n \\"PrometheusClusterId\\": \\"保留字段。\\",\\n \\"PrometheusClusterRegion\\": \\"保留字段。\\"\\n }\\n },\\n \\"AvailableAssertions\\": [\\n {\\n \\"Type\\": \\"websiteTTLB\\",\\n \\"Target\\": \\"key\\\\n\\",\\n \\"Operator\\": \\"gt\\",\\n \\"Expect\\": \\"100\\"\\n }\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"ResourceGroupId\\": \\"default\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"user1\\",\\n \\"Value\\": \\"p_运维\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'GetTimingSyntheticTask', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'changeSet' => [ + ['createdAt' => '2024-04-12T06:35:24.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-14T12:26:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-03-01T02:14:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-02-23T06:20:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-10-26T12:34:24.000Z', 'description' => 'Response parameters changed'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"41877338-646B-5DD6-BFBE-F89F1E7245AD\\\\\\",\\\\n \\\\\\"Data\\\\\\": \\\\\\"{\\\\\\\\\\\\\\"clusterType\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"ManagedKubernetes\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"remoteWriteUrl\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"http:/\\\\\\" }\\",\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetClusterAllUrl', - ], - 'GetCloudClusterAllUrl' => [ - 'summary' => 'Queries the read and write URLs of a CloudMonitor instance, such as Pushgateway and Grafana URLs.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTimingSyntheticTask'], + ], ], + 'ramActions' => [], + ], + 'GetTrace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'TraceID', + 'in' => 'query', + 'schema' => ['description' => 'The trace ID. You can log on to the ARMS console and obtain the trace ID on the **Trace Query** page or **Interface Snapshot** tab.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'ac14001a15954493811405707d****', 'title' => ''], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-beijing', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the CloudMonitor instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ca9676014babd4', - ], + 'schema' => ['title' => '', 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n" + ."\n" + .'> If the ID of the trace is 30 characters in length, this parameter is optional. Otherwise, this parameter is required.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1623827602000'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n" + ."\n" + .'> If the ID of the trace is 30 characters in length, this parameter is optional. Otherwise, this parameter is required.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1623827603000'], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries on each page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', - ], - 'Data' => [ - 'description' => 'An array object.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', 'title' => ''], + 'Spans' => [ + 'description' => 'The details of the trace.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The queried global aggregation instances. The value is a JSON string.'."\n", 'type' => 'object', 'properties' => [ - 'ProductCode' => [ - 'description' => 'The identifier of the cloud service.'."\n", - 'type' => 'string', - 'example' => 'amp', - ], - 'Region' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'RemoteUrl' => [ - 'description' => 'The URLs for remote read and write. The value is a JSON string.'."\n", - 'type' => 'object', - 'properties' => [ - 'RemoteWriteUrl' => [ - 'description' => 'The internal URL for remote write.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'InternetRemoteWriteUrl' => [ - 'description' => 'The public URL for remote write.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'RemoteReadUrl' => [ - 'description' => 'The internal URL for remote read.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'InternetRemoteReadUrl' => [ - 'description' => 'The public URL for remote read.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"', - ], - 'GrafanaUrl' => [ - 'description' => 'The internal URL for Grafana.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'InternetGrafanaUrl' => [ - 'description' => 'The public URL for Grafana.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'InternetPushGatewayUrl' => [ - 'description' => 'The public URL for Pushgateway.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'PushGatewayUrl' => [ - 'description' => 'The internal URL for Pushgateway.'."\n", - 'type' => 'string', - 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", - ], - 'AuthToken' => [ - 'description' => 'Indicates whether authentication is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'SpanId' => ['description' => 'The span ID.'."\n", 'type' => 'string', 'example' => '1234', 'title' => ''], + 'OperationName' => ['description' => 'The name of the traced span.'."\n", 'type' => 'string', 'example' => '/api/demo', 'title' => ''], + 'ResultCode' => ['description' => 'The status code.'."\n", 'type' => 'string', 'example' => '222', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp generated when the span was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590388651', 'title' => ''], + 'RpcType' => ['description' => 'The type of the remote procedure call (RPC) mode.'."\n" + ."\n" + .'* 0: HTTP entry'."\n" + .'* 25: HTTP call'."\n" + .'* 1: High-speed Service Framework (HSF) call'."\n" + .'* 2: HSF provision'."\n" + .'* 40: on-premises API call'."\n" + .'* 60: MySQL call'."\n" + .'* 62: Oracle call'."\n" + .'* 63: PostgreSQL call'."\n" + .'* 70: Redis call'."\n" + .'* 4: Taobao Distributed Data Layer (TDDL) call'."\n" + .'* 5: Tair call'."\n" + .'* 13: MetaQ message sending'."\n" + .'* 252: MetaQ message receiving'."\n" + .'* 3: notification sending'."\n" + .'* 254: notification receiving'."\n" + .'* 7: Apache Dubbo call'."\n" + .'* 8: Apache Dubbo provision'."\n" + .'* 19: SOFARPC call'."\n" + .'* 18: SOFARPC provision'."\n" + .'* 11: Distributed Service Framework (DSF) call'."\n" + .'* 12: DSF provision'."\n" + .'* \\-1: unknown call'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'ServiceIp' => ['description' => 'The IP address of the host where the application resides.'."\n", 'type' => 'string', 'example' => '172.20.XX.XX', 'title' => ''], + 'HaveStack' => ['description' => 'Indicates whether a method stack was provided.'."\n" + ."\n" + .'* `true`: A method stack was provided.'."\n" + .'* `false`: No method stack was provided.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'ParentSpanId' => ['description' => 'The ID of the parent span.'."\n", 'type' => 'string', 'example' => '18', 'title' => ''], + 'Duration' => ['description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1000', 'title' => ''], + 'RpcId' => ['description' => 'The ID of the RPC mode.'."\n", 'type' => 'string', 'example' => '0', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'arms-demo', 'title' => ''], + 'TraceID' => ['description' => 'The trace ID.'."\n", 'type' => 'string', 'example' => 'ac14001a15954493811405707d****', 'title' => ''], + 'TagEntryList' => [ + 'description' => 'The tags of the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'http.status.code', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], ], - 'Token' => [ - 'description' => 'The token value used for authentication.'."\n", - 'type' => 'string', - 'example' => '"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw"', + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'LogEventList' => [ + 'description' => 'The log events in the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => ['description' => 'The timestamp when the log event was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1590388651', 'title' => ''], + 'TagEntryList' => [ + 'description' => 'The tags of the trace.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'example' => 'http.status.code', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', + ], + 'Children' => [ + 'description' => 'The child spans of the current span.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The details of the child span.'."\n", 'type' => 'object', 'example' => '[ { "ParentSpanId":"c33603355032xxxx", "ServiceIp":"10.208.xxx.xxx", "OperationName":"/product/toy/8ac7ddeb-1c3c-4911-850c-665a5a0xxxx", "RpcType":0, "Duration":2, "TagEntryList":[ { "Value":"10.208.0.xxx", "Key":"source.ip" } ], "Timestamp":1652669026201, "HaveStack":true, "LogEventList":[ ], "ServiceName":"xxxxxx", "RpcId":"0.2", "TraceID":"ea1ad000a1165266902619685xxxxx", "Children":[ ], "ResultCode":"0", "SpanId":"7069ab30d7cbxxxx" } ]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'substitutions' => [ - 'ARMS::2019-08-08::GetRemoteWriteUrl', - ], - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"99A663CB-8D7B-4B0D-A006-03C8EE38E7BB\\",\\n \\"Data\\": [\\n {\\n \\"ProductCode\\": \\"amp\\",\\n \\"Region\\": \\"cn-hangzhou\\",\\n \\"RemoteUrl\\": {\\n \\"RemoteWriteUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetRemoteWriteUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"RemoteReadUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetRemoteReadUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\",\\n \\"GrafanaUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetGrafanaUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"InternetPushGatewayUrl\\": \\"\\\\\\"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"PushGatewayUrl\\": \\"\\\\\\"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX\\\\\\"\\\\n\\",\\n \\"AuthToken\\": true,\\n \\"Token\\": \\"\\\\\\"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw\\\\\\"\\"\\n }\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', - 'title' => 'GetCloudClusterAllUrl', - ], - 'ListPrometheusInstances' => [ - 'summary' => 'Obtains all Prometheus instances in a region.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Spans\\": [\\n {\\n \\"SpanId\\": \\"1234\\",\\n \\"OperationName\\": \\"/api/demo\\",\\n \\"ResultCode\\": \\"222\\",\\n \\"Timestamp\\": 1590388651,\\n \\"RpcType\\": 1,\\n \\"ServiceIp\\": \\"172.20.XX.XX\\",\\n \\"HaveStack\\": false,\\n \\"ParentSpanId\\": \\"18\\",\\n \\"Duration\\": 1000,\\n \\"RpcId\\": \\"0\\",\\n \\"ServiceName\\": \\"arms-demo\\",\\n \\"TraceID\\": \\"ac14001a15954493811405707d****\\",\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ],\\n \\"LogEventList\\": [\\n {\\n \\"Timestamp\\": 1590388651,\\n \\"TagEntryList\\": [\\n {\\n \\"Key\\": \\"http.status.code\\",\\n \\"Value\\": \\"200\\"\\n }\\n ]\\n }\\n ],\\n \\"Children\\": [\\n [\\n {\\n \\"ParentSpanId\\": \\"c33603355032xxxx\\",\\n \\"ServiceIp\\": \\"10.208.xxx.xxx\\",\\n \\"OperationName\\": \\"/product/toy/8ac7ddeb-1c3c-4911-850c-665a5a0xxxx\\",\\n \\"RpcType\\": 0,\\n \\"Duration\\": 2,\\n \\"TagEntryList\\": [\\n {\\n \\"Value\\": \\"10.208.0.xxx\\",\\n \\"Key\\": \\"source.ip\\"\\n }\\n ],\\n \\"Timestamp\\": 1652669026201,\\n \\"HaveStack\\": true,\\n \\"LogEventList\\": [],\\n \\"ServiceName\\": \\"xxxxxx\\",\\n \\"RpcId\\": \\"0.2\\",\\n \\"TraceID\\": \\"ea1ad000a1165266902619685xxxxx\\",\\n \\"Children\\": [],\\n \\"ResultCode\\": \\"0\\",\\n \\"SpanId\\": \\"7069ab30d7cbxxxx\\"\\n }\\n ]\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<GetTraceResponse>\\n <RequestId>6A9AEA84-7186-4D8D-B498-4585C6A2****</RequestId>\\n <Spans>\\n <SpanId>1234</SpanId>\\n <OperationName>/api/demo</OperationName>\\n <ResultCode>222</ResultCode>\\n <Timestamp>1590388651</Timestamp>\\n <RpcType>1</RpcType>\\n <ServiceIp>172.20.XX.XX</ServiceIp>\\n <HaveStack>false</HaveStack>\\n <ParentSpanId>18</ParentSpanId>\\n <Duration>1000</Duration>\\n <RpcId>0</RpcId>\\n <ServiceName>arms-demo</ServiceName>\\n <TraceID>ac14001a15954493811405707d****</TraceID>\\n <TagEntryList>\\n <Key>http.status.code</Key>\\n <Value>200</Value>\\n </TagEntryList>\\n <LogEventList>\\n <Timestamp>1590388651</Timestamp>\\n <TagEntryList>\\n <Key>http.status.code</Key>\\n <Value>200</Value>\\n </TagEntryList>\\n </LogEventList>\\n <Children/>\\n </Spans>\\n</GetTraceResponse>","errorExample":""}]', + 'title' => 'GetTrace', + 'summary' => 'Queries the details of a trace.', + 'description' => '> You must use Application Real-Time Monitoring Service (ARMS) SDK for Java V2.7.24.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2025-02-21T07:06:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-15T12:40:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-28T03:08:09.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'GetTraceApp' => [ + 'summary' => 'Queries the details of an application monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22245,618 +17221,844 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The process identifier (PID) of the application. For more information about how to obtain the PID, see [Obtain the PID of an application](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b590lhguqs@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'ClusterType', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '实例类型。', - 'description' => 'The cluster type. If you do not specify this parameter, all cluster types are queried. Valid values:'."\n" - ."\n" - .'* cloud-product-prometheus: Prometheus instance for cloud services'."\n" - .'* ManagedKubernetes: ACK managed cluster'."\n" - .'* satellite: Prometheus instance for ARMS OpenTelemetry'."\n" - .'* Ask: ACK Serverless cluster'."\n" - .'* remote-write-prometheus: general-purpose Prometheus instance'."\n" - .'* cloud-monitor-cmee: Hybrid Cloud Monitoring'."\n" - .'* ExternalKubernetes: external Kubernetes cluster registered in ACK'."\n" - .'* vpc-prometheus: Prometheus instance for ECS'."\n" - .'* cloud-monitor-direct: cloud service self-monitoring'."\n" - .'* Edge Kubernetes: ACK Edge cluster'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'enumValueTitles' => [], - 'example' => 'cloud-product-prometheus', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ShowGlobalView', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to obtain global aggregation instances. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The list of tags.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ - 'Data' => [ - 'description' => 'The Prometheus instances in the region in the JSON format.'."\n", - 'type' => 'string', - 'example' => '[{"agentStatus":"0","clusterId":"global-v2-cn-1672753017899-dmjnwtzz","clusterName":"test-GlobalView","clusterType":"GlobalViewV2","commercialConfig":{},"createTime":1656579981000,"id":13785300,"isAdvancedClusterInstalled":false,"isClusterRunning":true,"isControllerInstalled":true,"isIntegrationCenter":false,"regionId":"cn-hongkong","updateTime":1657616273000,"userId":"1672753017899"},{"agentStatus":"0","clusterId":"51a123a61a8f31f0","clusterName":"cloud-product-prometheus_cn-qingdao","clusterType":"cloud-product-prometheus","commercialConfig":{},"controllerId":"51a123a61a8f31f0","createTime":1653532488000,"id":13746658,"isAdvancedClusterInstalled":false,"isClusterRunning":true,"isControllerInstalled":true,"isIntegrationCenter":false,"regionId":"cn-qingdao","updateTime":1653532518000,"userId":"1672753017899"}]', - ], - 'RequestId' => [ - 'description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', - ], - 'Code' => [ - 'description' => 'The status code.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.', - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', 'title' => ''], + 'TraceApp' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'* `TRACE`: Application Monitoring'."\n" + .'* `RETCODE`: Browser Monitoring'."\n", 'type' => 'string', 'example' => 'TRACE', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'arms-k8s-demo', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp generated when the task information was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1635700348000', 'title' => ''], + 'Show' => ['description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp generated when the task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1576599253000', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'b590lhguqs@d8deedfa9bf****', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Labels' => [ + 'description' => 'The aliases of the application.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tags of the application.'."\n", 'type' => 'string', 'example' => '[ "test", "123123123", "uat" ],', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'A list of key-value pairs.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Source' => ['description' => 'The source of the application.'."\n", 'type' => 'string', 'example' => 'ACSK8S', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c905d1364c2dd4b6284a3f41790c4****', 'title' => ''], + 'Language' => ['description' => 'The programming language of the application.'."\n", 'type' => 'string', 'example' => 'java', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\"agentStatus\\\\\\":\\\\\\"0\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"global-v2-cn-1672753017899-dmjnwtzz\\\\\\",\\\\\\"clusterName\\\\\\":\\\\\\"test-GlobalView\\\\\\",\\\\\\"clusterType\\\\\\":\\\\\\"GlobalViewV2\\\\\\",\\\\\\"commercialConfig\\\\\\":{},\\\\\\"createTime\\\\\\":1656579981000,\\\\\\"id\\\\\\":13785300,\\\\\\"isAdvancedClusterInstalled\\\\\\":false,\\\\\\"isClusterRunning\\\\\\":true,\\\\\\"isControllerInstalled\\\\\\":true,\\\\\\"isIntegrationCenter\\\\\\":false,\\\\\\"regionId\\\\\\":\\\\\\"cn-hongkong\\\\\\",\\\\\\"updateTime\\\\\\":1657616273000,\\\\\\"userId\\\\\\":\\\\\\"1672753017899\\\\\\"},{\\\\\\"agentStatus\\\\\\":\\\\\\"0\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"51a123a61a8f31f0\\\\\\",\\\\\\"clusterName\\\\\\":\\\\\\"cloud-product-prometheus_cn-qingdao\\\\\\",\\\\\\"clusterType\\\\\\":\\\\\\"cloud-product-prometheus\\\\\\",\\\\\\"commercialConfig\\\\\\":{},\\\\\\"controllerId\\\\\\":\\\\\\"51a123a61a8f31f0\\\\\\",\\\\\\"createTime\\\\\\":1653532488000,\\\\\\"id\\\\\\":13746658,\\\\\\"isAdvancedClusterInstalled\\\\\\":false,\\\\\\"isClusterRunning\\\\\\":true,\\\\\\"isControllerInstalled\\\\\\":true,\\\\\\"isIntegrationCenter\\\\\\":false,\\\\\\"regionId\\\\\\":\\\\\\"cn-qingdao\\\\\\",\\\\\\"updateTime\\\\\\":1653532518000,\\\\\\"userId\\\\\\":\\\\\\"1672753017899\\\\\\"}]\\",\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListPrometheusInstancesResponse>\\n <Data>[{\\"agentStatus\\":\\"0\\",\\"clusterId\\":\\"global-v2-cn-1672753017899-dmjnwtzz\\",\\"clusterName\\":\\"test-GlobalView\\",\\"clusterType\\":\\"GlobalViewV2\\",\\"commercialConfig\\":{},\\"createTime\\":1656579981000,\\"id\\":13785300,\\"isAdvancedClusterInstalled\\":false,\\"isClusterRunning\\":true,\\"isControllerInstalled\\":true,\\"isIntegrationCenter\\":false,\\"regionId\\":\\"cn-hongkong\\",\\"updateTime\\":1657616273000,\\"userId\\":\\"1672753017899\\"},{\\"agentStatus\\":\\"0\\",\\"clusterId\\":\\"51a123a61a8f31f0\\",\\"clusterName\\":\\"cloud-product-prometheus_cn-qingdao\\",\\"clusterType\\":\\"cloud-product-prometheus\\",\\"commercialConfig\\":{},\\"controllerId\\":\\"51a123a61a8f31f0\\",\\"createTime\\":1653532488000,\\"id\\":13746658,\\"isAdvancedClusterInstalled\\":false,\\"isClusterRunning\\":true,\\"isControllerInstalled\\":true,\\"isIntegrationCenter\\":false,\\"regionId\\":\\"cn-qingdao\\",\\"updateTime\\":1653532518000,\\"userId\\":\\"1672753017899\\"}]</Data>\\n <RequestId>E9C9DA3D-10FE-472E-9EEF-2D0A3E41****</RequestId>\\n</ListPrometheusInstancesResponse>","errorExample":""}]', - 'title' => 'ListPrometheusInstances', - ], - 'InstallManagedPrometheus' => [ - 'summary' => 'Installs a Prometheus agent for serverless Kubernetes (ASK) clusters or Elastic Compute Service (ECS) clusters.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"D80ADAAC-8C32-5479-BD14-C28CF832****\\",\\n \\"TraceApp\\": {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"arms-k8s-demo\\",\\n \\"UpdateTime\\": 1635700348000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1576599253000,\\n \\"Pid\\": \\"b590lhguqs@d8deedfa9bf****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"[ \\\\\\"test\\\\\\", \\\\\\"123123123\\\\\\", \\\\\\"uat\\\\\\" ],\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"Source\\": \\"ACSK8S\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"ClusterId\\": \\"c905d1364c2dd4b6284a3f41790c4****\\",\\n \\"Language\\": \\"java\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetTraceAppResponse>\\n <RequestId>D80ADAAC-8C32-5479-BD14-C28CF832****</RequestId>\\n <TraceApp>\\n <Type>TRACE</Type>\\n <AppId>123</AppId>\\n <UserId>113197164949****</UserId>\\n <CreateTime>1576599253000</CreateTime>\\n <UpdateTime>1635700348000</UpdateTime>\\n <Pid>b590lhguqs@d8deedfa9bfxxxx</Pid>\\n <Show>true</Show>\\n <Labels>test</Labels>\\n <Labels>123123123</Labels>\\n <Labels>uat</Labels>\\n <RegionId>cn-hangzhou</RegionId>\\n <AppName>arms-k8s-demo</AppName>\\n </TraceApp>\\n</GetTraceAppResponse>","errorExample":""}]', + 'title' => 'GetTraceApp', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-05-30T02:25:59.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-25T02:25:54.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-03T03:47:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-03T03:36:45.000Z', 'description' => 'Request parameters changed, Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-21T09:05:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-11-29T06:06:45.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'GetTraceAppConfig' => [ + 'summary' => 'Queries all custom settings of an application monitored by Application Monitoring, such as trace sampling settings and agent switches. This operation is applicable only to applications that are monitored by Application Monitoring. It is not applicable to applications that are monitored by Managed Service for OpenTelemetry.', + 'methods' => ['get', 'post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '118951', - 'abilityTreeNodes' => [ - 'FEATUREarmsC7S24K', - ], - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The process ID (PID) of the application.'."\n" + ."\n" + .'You can use one of the following methods to obtain the PID:'."\n" + ."\n" + .'* API: Call the [ListTraceApps](~~2588008~~) operation'."\n" + .'* Console: Log on to the Application Real-Time Monitoring Service (ARMS) console. In the left-side navigation pane, choose **Application Monitoring** > **Application List**. On the Application List page, click the name of your application. The URL in the address bar contains the PID of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with an at sign (@) to obtain xxx@74xxx.'."\n" + ."\n" + .'> '."\n" + ."\n" + .'* To obtain the PID in the console, your application must be monitored by Application Monitoring rather than Managed Service for OpenTelemetry.'."\n" + ."\n" + .'* The GetTraceAppConfig operation can query only the custom settings of applications that are monitored by Application Monitoring.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a2n80plglh@745eddxxx'."\n", 'title' => ''], ], - [ - 'name' => 'ClusterId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'ClusterType为ask时，必填', - 'description' => 'The ID of the ASK cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'."\n", 'title' => ''], + 'Data' => ['description' => 'The custom settings of the application, which is a JSON string. For more information, see **Additional description of response parameters**.'."\n", 'type' => 'string', 'example' => '{"profiler":{"enable":true}}', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => '查询应用配置成功', 'title' => ''], + 'Code' => [ + 'description' => 'The HTTP status code.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 2xx: The request was successful.'."\n" + .'* 3xx: The request was redirected.'."\n" + .'* 4xx: A request error occurred.'."\n" + .'* 5xx: A server error occurred.'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => ['2xx' => '', '3xx' => '', '4xx' => '', '5xx' => ''], + 'example' => '200', + 'title' => '', + ], + 'Success' => [ + 'description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", + 'type' => 'boolean', + 'enumValueTitles' => ['true' => '', 'false' => ''], + 'example' => 'true', + 'title' => '', + ], + ], + 'example' => '', ], ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例的资源组id', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterPidMissing', 'errorMessage' => 'You must specify pid.', 'description' => 'You must specify pid.'], + ], + 404 => [ + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The application does not exist.', 'description' => 'The application does not exist.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\\\n\\",\\n \\"Data\\": \\"{\\\\\\"profiler\\\\\\":{\\\\\\"enable\\\\\\":true}}\\",\\n \\"Message\\": \\"查询应用配置成功\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + 'title' => 'GetTraceAppConfig', + 'responseParamsDescription' => 'The following tables describe the JSONPath parameter corresponding to each custom setting. Note: **Some custom settings may not be returned in the response** because they are modified at different points in time. In this case, the default values take effect.'."\n" + ."\n" + .'**Sampling settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Sampling policy|profiler.sampling.useSamplingStrategyV2|boolean|Valid values:<br />\\- `true`: adaptive sampling<br />\\- `false`: fixed-rate sampling|false|'."\n" + .'|Sampling rate|profiler.sampling.rate|double|0% to 100%<br />This setting takes effect for fixed-rate sampling.|10|'."\n" + .'|API endpoint for full collection|profiler.sampling.v2config.spanNames4FullSampleStr|String|The API endpoint whose trace data is collected. Separate multiple values with commas (,).|""|'."\n" + .'|API endpoint prefix for full collection|profiler.sampling.v2config.spanNamePrefixes4FullSampleStr|String|The prefix of the API endpoint whose trace data is collected.|""|'."\n" + .'|API endpoint suffix for full collection|profiler.sampling.v2config.spanNameSuffixes4FullSampleStr|String|The suffix of the API endpoint whose trace data is collected.|""|'."\n" + ."\n" + .'**Agent switch settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Application Monitoring switch|profiler.enable|boolean|Valid values:<br />\\- `true`: enables Application Monitoring<br />\\- `false`: disables Application Monitoring|true|'."\n" + .'|Dubbo plug-in switch|profiler.dubbo.enable|boolean|Valid values:<br />\\- `true`: enables the Dubbo plug-in<br />\\- `false`: disables the Dubbo plug-in|true|'."\n" + .'|MongoDB plug-in switch|profiler.mongodb.enable|boolean|Valid values:<br />\\- `true`: enables the MongoDB plug-in<br />\\- `false`: disables the MongoDB plug-in|true|'."\n" + .'|HSF plug-in switch|profiler.hsf.enable|boolean|Valid values:<br />\\- `true`: enables the HSF plug-in<br />\\- `false`: disables the HSF plug-in|true|'."\n" + .'|HttpClient 3 plug-in switch|profiler.httpclient3.enable|boolean|Valid values:<br />\\- `true`: enables the HttpClient 3 plug-in<br />\\- `false`: disables the HttpClient 3 plug-in|true|'."\n" + .'|HttpClient 4 plug-in switch|profiler.httpclient4.enable|boolean|Valid values:<br />\\- `true`: enables the HttpClient 4 plug-in<br />\\- `false`: disables the HttpClient 4 plug-in|true|'."\n" + .'|JDK HTTP plug-in switch|profiler.jdkhttp.enable|boolean|Valid values:<br />\\- `true`: enables the JDK HTTP plug-in<br />\\- `false`: disables the JDK HTTP plug-in|true|'."\n" + .'|Jetty plug-in switch|profiler.jetty.enable|boolean|Valid values:<br />\\- `true`: enables the Jetty plug-in<br />\\- `false`: disables the Jetty plug-in|true|'."\n" + .'|MyBatis plug-in switch|profiler.mybatis.enable|boolean|Valid values:<br />\\- `true`: enables the MyBatis plug-in<br />\\- `false`: disables the MyBatis plug-in|true|'."\n" + .'|MySQL plug-in switch|profiler.mysql.enable|boolean|Valid values:<br />\\- `true`: enables the MySQL plug-in<br />\\- `false`: disables the MySQL plug-in|true|'."\n" + .'|OkHttp plug-in switch|profiler.okhttp.enable|boolean|Valid values:<br />\\- `true`: enables the OkHttp plug-in<br />\\- `false`: disables the OkHttp plug-in|true|'."\n" + .'|Oracle plug-in switch|profiler.oracle.enable|boolean|Valid values:<br />\\- `true`: enables the Oracle plug-in<br />\\- `false`: disables the Oracle plug-in|true|'."\n" + .'|PostgreSQL plug-in switch|profiler.postgresql.enable|boolean|Valid values:<br />\\- `true`: enables the PostgreSQL plug-in<br />\\- `false`: disables the PostgreSQL plug-in|true|'."\n" + .'|Redis plug-in switch|profiler.redis.enable|boolean|Valid values:<br />\\- `true`: enables the Redis plug-in<br />\\- `false`: disables the Redis plug-in|true|'."\n" + .'|Spring plug-in switch|profiler.spring.enable|boolean|Valid values:<br />\\- `true`: enables the Spring plug-in<br />\\- `false`: disables the Spring plug-in|true|'."\n" + .'|Spring Boot plug-in switch|profiler.springboot.enable|boolean|Valid values:<br />\\- `true`: enables the Spring Boot plug-in<br />\\- `false`: disables the Spring Boot plug-in|true|'."\n" + .'|Tomcat plug-in switch|profiler.tomcat.enable|boolean|Valid values:<br />\\- `true`: enables the Tomcat plug-in<br />\\- `false`: disables the Tomcat plug-in|true|'."\n" + .'|Lettuce plug-in switch|profiler.lettuce.enable|boolean|Valid values:<br />\\- `true`: enables the Lettuce plug-in<br />\\- `false`: disables the Lettuce plug-in|true|'."\n" + .'|gRPC plug-in switch|profiler.grpc.enable|boolean|Valid values:<br />\\- `true`: enables the gRPC plug-in<br />\\- `false`: disables the gRPC plug-in|true|'."\n" + .'|Thrift plug-in switch|profiler.thrift.enable|boolean|Valid values:<br />\\- `true`: enables the Thrift plug-in<br />\\- `false`: disables the Thrift plug-in|true|'."\n" + .'|Hystrix plug-in switch|profiler.hystrix.enable|boolean|Valid values:<br />\\- `true`: enables the Hystrix plug-in<br />\\- `false`: disables the Hystrix plug-in|true|'."\n" + .'|RxJava plug-in switch|profiler.rxjava.enable|boolean|Valid values:<br />\\- `true`: enables the RxJava plug-in<br />\\- `false`: disables the RxJava plug-in|true|'."\n" + .'|Memcached plug-in switch|profiler.memcached.enable|boolean|Valid values:<br />\\- `true`: enables the Memcached plug-in<br />\\- `false`: disables the Memcached plug-in|true|'."\n" + .'|Druid plug-in switch|profiler.jdbc.druid.enable|boolean|Valid values:<br />\\- `true`: enables the Druid plug-in<br />\\- `false`: disables the Druid plug-in|true|'."\n" + .'|WebLogic plug-in switch|profiler.weblogic.enable|boolean|Valid values:<br />\\- `true`: enables the WebLogic plug-in<br />\\- `false`: disables the WebLogic plug-in|true|'."\n" + .'|ElasticJob plug-in switch|profiler.elasticjob.enable|boolean|Valid values:<br />\\- `true`: enables the ElasticJob plug-in<br />\\- `false`: disables the ElasticJob plug-in|true|'."\n" + .'|Elasticsearch plug-in switch|profiler.elasticsearch.enable|boolean|Valid values:<br />\\- `true`: enables the Elasticsearch plug-in<br />\\- `false`: disables the Elasticsearch plug-in|true|'."\n" + .'|HikariCP plug-in switch|profiler.jdbc.hikaricp.enable|boolean|Valid values:<br />\\- `true`: enables the HikariCP plug-in<br />\\- `false`: disables the HikariCP plug-in|true|'."\n" + .'|InfluxDB plug-in switch|profiler.influxdb.enable|boolean|Valid values:<br />\\- `true`: enables the InfluxDB plug-in<br />\\- `false`: disables the InfluxDB plug-in|true|'."\n" + .'|Kafka plug-in switch|profiler.kafka.enable|boolean|Valid values:<br />\\- `true`: enables the Kafka plug-in<br />\\- `false`: disables the Kafka plug-in|true|'."\n" + .'|Netty plug-in switch|profiler.netty.enable|boolean|Valid values:<br />\\- `true`: enables the Netty plug-in<br />\\- `false`: disables the Netty plug-in|true|'."\n" + .'|Play plug-in switch|profiler.play.enable|boolean|Valid values:<br />\\- `true`: enables the Play plug-in<br />\\- `false`: disables the Play plug-in|true|'."\n" + .'|Reactor plug-in switch|profiler.reactor.enable|boolean|Valid values:<br />\\- `true`: enables the Reactor plug-in<br />\\- `false`: disables the Reactor plug-in|true|'."\n" + .'|Redisson plug-in switch|profiler.redis.redisson.enable|boolean|Valid values:<br />\\- `true`: enables the Redisson plug-in<br />\\- `false`: disables the Redisson plug-in|true|'."\n" + .'|RabbitMQ plug-in switch|profiler.rabbitmq.client.enable|boolean|Valid values:<br />\\- `true`: enables the RabbitMQ plug-in<br />\\- `false`: disables the RabbitMQ plug-in|true|'."\n" + .'|SchedulerX plug-in switch|profiler.schedulerx.enable|boolean|Valid values:<br />\\- `true`: enables the SchedulerX plug-in<br />\\- `false`: disables the SchedulerX plug-in|true|'."\n" + .'|Undertow plug-in switch|profiler.undertow.enable|boolean|Valid values:<br />\\- `true`: enables the Undertow plug-in<br />\\- `false`: disables the Undertow plug-in|true|'."\n" + .'|Vert.x plug-in switch|profiler.vertx.enable|boolean|Valid values:<br />\\- `true`: enables the Vert.x plug-in<br />\\- `false`: disables the Vert.x plug-in|true|'."\n" + .'|XXL-JOB plug-in switch|profiler.xxljob.enable|boolean|Valid values:<br />\\- `true`: enables the XXL-JOB plug-in<br />\\- `false`: disables the XXL-JOB plug-in|true|'."\n" + .'|ONS Client plug-in switch|profiler.onsclient.enable|boolean|Valid values:<br />\\- `true`: enables the ONS Client plug-in<br />\\- `false`: disables the ONS Client plug-in|true|'."\n" + .'|Quartz plug-in switch|profiler.quartz.enable|boolean|Valid values:<br />\\- `true`: enables the Quartz plug-in<br />\\- `false`: disables the Quartz plug-in|true|'."\n" + .'|Servlet plug-in switch|profiler.servlet.enable|boolean|Valid values:<br />\\- `true`: enables the Servlet plug-in<br />\\- `false`: disables the Servlet plug-in|true|'."\n" + .'|Liberty plug-in switch|profiler.liberty.enable|boolean|Valid values:<br />\\- `true`: enables the Liberty plug-in<br />\\- `false`: disables the Liberty plug-in|true|'."\n" + .'|Akka plug-in switch|profiler.akka.enable|boolean|Valid values:<br />\\- `true`: enables the Akka plug-in<br />\\- `false`: disables the Akka plug-in|true|'."\n" + .'|Cassandra plug-in switch|profiler.cassandra.enable|boolean|Valid values:<br />\\- `true`: enables the Cassandra plug-in<br />\\- `false`: disables the Cassandra plug-in|true|'."\n" + .'|OpenTelemetry plug-in switch|profiler.opentelemetry.enable|boolean|Valid values:<br />\\- `true`: enables the OpenTelemetry plug-in<br />\\- `false`: disables the OpenTelemetry plug-in|true|'."\n" + .'|Google HTTP Client plug-in switch|profiler.googlehttpclient.enable|boolean|Valid values:<br />\\- `true`: enables the Google HTTP Client plug-in<br />\\- `false`: disables the Google HTTP Client plug-in|true|'."\n" + .'|Ning plug-in switch|profiler.ning.asynchttpclient.enable|boolean|Valid values:<br />\\- `true`: enables the Ning plug-in<br />\\- `false`: disables the Ning plug-in|true|'."\n" + ."\n" + .'**Thread profiling settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Thread profiling switch|profiler.tprof.enableJvmThreadStatistic|boolean|Valid values:<br />\\- `true`: enables thread profiling<br />\\- `false`: disables thread profiling|true|'."\n" + .'|Switch for periodically saving local method stacks|profiler.tprof.enableThreadStackRecorder|boolean|Valid values:<br />\\- `true`: enables periodic storage of local method stacks<br />\\- `false`: disables periodic storage of local method stacks|false|'."\n" + .'|Threshold for time-consuming calls|profiler.tprof. threadProfilerSlowInteractionRt|int|Unit: ms. If the duration exceeds the threshold, the local method stack is automatically saved.|2000|'."\n" + ."\n" + .'**Application log association settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Log source|profiler.logSource|String|Valid values:<br />\\- `sls`: Simple Log Service|sls|'."\n" + .'|Switch for automatically associating business logs with trace IDs|profiler.logging.enable|boolean|Valid values:<br />\\- `true`: enables the association of business logs with trace IDs<br />\\- `false`: disables the association of business logs with trace IDs|true|'."\n" + .'|Switch for automatically filling in trace IDs in logs|profiler.logging.injectTraceId2Log.enable|boolean|Valid values:<br />\\- `true`: enables the automatic filling of span IDs in logs<br />\\- `false`: disables the automatic filling of span IDs in logs<br />This setting takes effect for ARMS agents V4.1.6 or later.|true|'."\n" + .'|Switch for automatically filling in span IDs in logs|profiler.logging.injectSpanId2Log.enable|boolean|Valid values:<br />\\- `true`: enables the automatic filling of span IDs in logs<br />\\- `false`: disables the automatic filling of span IDs in logs<br />This setting takes effect for ARMS agents V4.1.6 or later.|true|'."\n" + .'|Associate Simple Log Service - Region|profiler.SLS.regionId|String|The region where the associated log source resides.|""|'."\n" + .'|Associate Simple Log Service - Project|profiler.SLS.project|String|The project to which the associated log source belongs.|""|'."\n" + .'|Associate Simple Log Service - Logstore|profiler.SLS.logStore|String|The Logstore to which the associated log source belongs.|""|'."\n" + .'|Associate Simple Log Service - Associated index|profiler.SLS.index|String|The index of the associated log source.|""|'."\n" + ."\n" + .'**URL convergence settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Convergence URL|profiler.convergence.enable|boolean|Valid values:<br />\\- `true`: enables the URL convergence feature<br />\\- `false`: disables the URL convergence feature|true|'."\n" + .'|Convergence threshold|profiler.convergence.minServerSize|long|URLs are converged when the threshold is reached.|1000|'."\n" + .'|Convergence rule|profiler.convergence.pattern|String|Each rule is a regular expression.<br />Example: `/service/(.*?)/demo`.<br />Separate multiple rules with commas (,).|""|'."\n" + ."\n" + .'**Arthas settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Arthas switch|profiler.arthas.enable|boolean|Valid values:<br />\\- `true`: enables the Arthas diagnostics feature<br />\\- `false`: disables the Arthas diagnostics feature|false|'."\n" + .'|IP address effective in real time|profiler.arthas.enableIps|string|The IP addresses for which the Arthas diagnostics feature is enabled. Separate multiple IP addresses with commas (,).<br />**An empty string indicates that the Arthas diagnostics feature is enabled for all IP addresses.**|""|'."\n" + ."\n" + .'**Continuous profiling settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Switch|profiler.cp.enable|boolean|Valid values:<br />\\- `true`: enables the continuous profiling feature<br />\\- `false`: disables the continuous profiling feature<br />\\* After the switch is turned on, two configuration modes are available, as shown in the following table.|false|'."\n" + .'|CPU hotspot|profiler.cp.cpuEnable|boolean|Valid values:<br />\\- `true`: enables the CPU hotspot feature<br />\\- `false`: disables the CPU hotspot feature|false|'."\n" + .'|Memory hotspot|profiler.cp.allocEnable|boolean|Valid values:<br />\\- `true`: enables the memory hotspot feature<br />\\- `false`: disables the memory hotspot feature|false|'."\n" + .'|Code hotspot|profiler.cp.wallClockEnable|boolean|Valid values:<br />\\- `true`: enables the code hotspot feature<br />\\- `false`: disables the code hotspot feature|false|'."\n" + ."\n" + .'|||||'."\n" + .'|---|---|---|---|'."\n" + .'|Mode|Key|Field|Value|'."\n" + .'|IP address whitelist|cp.allowIPs|IP address whitelist|The IP address of the instances for which continuous profiling is enabled. Separate multiple values with commas (,).<br />Example: 192.168.0.1,192.168.0.2|'."\n" + .'|cp.allowNetwork|CIDR block|Specify an empty string. Otherwise, this feature does not work properly.|'."\n" + .'|CIDR block|cp.allowIPs|IP address whitelist|Specify an empty string. Otherwise, this feature does not work properly.|'."\n" + .'|cp.allowNetwork|CIDR block|The CIDR block of the instances for which continuous profiling is enabled.<br />Example: 192.168.2.0/24/24|'."\n" + ."\n" + .'**Data masking settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Data masking switch|profiler.sanitizer.enable|boolean|Valid values:<br />\\- `true`: enables the data masking feature<br />\\- `false`: disables the data masking feature|true|'."\n" + .'|Data masking rule|profiler.sanitizer.keys|String|Case-insensitive matching of sensitive keys containing specified terms. Separate multiple IP addresses with commas (,).|true|'."\n" + ."\n" + .'**Operation call settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Slow request threshold|profiler.thresholds.interface|long|Unit: ms. If the response time is longer than this threshold, the request is marked as slow.|500|'."\n" + .'|Exception whitelist|profiler.exception.whitelist|String|Specify regular expressions for exception names, where matching exceptions are excluded from statistical charts. Separate multiple rules with commas (,).|""|'."\n" + .'|Exception filtering through parent class inheritance|profiler.exception.filterByParentClass|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature<br />After the feature is enabled, you can configure parent exceptions in exception filtering.<br />This setting takes effect for ARMS agents V4.1.6 or later.|true|'."\n" + .'|HTTP status code whitelist|profiler.error.skip|String|The HTTP status codes you want to ignore. Separate multiple values with commas (,).|""|'."\n" + .'|Filtering of invalid API calls|profiler.defined.excludeurl|String|The API calls that are ignored. Each rule is a regular expression. Separate multiple values with commas (,).|/\\*\\*/\\*.jpg,/\\*\\*/\\*.png,/\\*\\*/\\*.js,<br />/\\*\\*/\\*.jpeg,/\\*\\*/\\*.pdf,/\\*\\*/\\*.xlsx,<br />/\\*\\*/\\*.txt,/\\*\\*/\\*.docs,/\\*\\*/\\*.gif,<br />/\\*\\*/\\*.csv|'."\n" + ."\n" + .'**Database call settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Slow SQL query threshold|profiler.thresholds.sql|long|Unit: ms. If the duration of an SQL query exceeds the threshold, the query is marked as slow.|500|'."\n" + .'|Maximum SQL capture retention length|profiler.callsql.maxLength|long|If the value of an SQL statement exceeds the threshold, the SQL statement is truncated.|1024|'."\n" + .'|Switch for displaying bound variables in SQL statements|profiler.jdbc.tracesqlbindvalue|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature<br />If you turn on this switch, the variable values bound to the PrepareStatement parameter are captured and displayed on the page. **Only MySQL is supported.**|false|'."\n" + .'|Switch for displaying constants in SQL statements|profiler.jdbc. tracesqlraw|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature<br />After the feature is enabled, raw SQL statements are captured.|false|'."\n" + ."\n" + .'**Tracing protocol settings**'."\n" + ."\n" + .'****Note: The context propagation protocol settings take effect only for ARMS agents V4.1.x or later.****'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Context propagation protocol|profiler.trace.protocol.name|String|Valid values:<br />\\- `Unset`: not set<br />\\- `W3C`: OpenTelemetry W3C<br />\\- `SkyWalking`<br />\\- `Zipkin`: Zipkin B3<br />\\- `Jaeger`<br />\\- `EagleEye`|Unset|'."\n" + .'|Context propagation mode|profiler.trace.protocol. strategy|String|Valid values:<br />\\- `PriorityUse`<br />\\- `ForceUse`|PriorityUse|'."\n" + ."\n" + .'**Advanced settings**'."\n" + ."\n" + .'|Setting|JSONPath|Type|Description|Default value|'."\n" + .'|---|---|---|---|---|'."\n" + .'|Maximum number of traces collected by the agent per second|profiler.thresholds.limit|int|A protective measure to ensure business operations are not impacted by trace collection in high traffic.|100|'."\n" + .'|Method stack retention limit|profiler.callstack.maxLength|int|If the length of a method stack exceeds the threshold, the method stack is truncated during collection.<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|128|'."\n" + .'|Stack depth for same-type exceptions|profiler.exception.stacktrace|int|The stack depth based on which the system identifies the same type of exceptions.|2|'."\n" + .'|Maximum display length of request parameters|profiler.param.maxLength|int|The maximum display length of request parameters.|512|'."\n" + .'|Custom RabbitMQ consumer|profiler.rabbitmq.client.consumer.classes|String|The fully qualified class names of RabbitMQ consumers. Separate multiple consumers with commas (,).<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|""|'."\n" + .'|Custom Kafka consumption method|profiler.kafka.consumer.entryPoint|String|The consumption method of the Kafka consumer.<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|""|'."\n" + .'|Switch for automatically propagating context when Kafka sends messages|profiler.kafka.enableInjectKafkaHeaders|boolean|Specifies whether to automatically inject tracing headers to Kafka messages to associate the sending trace with the consumption trace.<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|false|'."\n" + .'|Package name for asynchronous propagation|profiler.thread.match.package|String|When a Runnable, Callable, Supplier under the specified package is created, the trace context is automatically captured and propagated to the new thread. Separate multiple package names with commas (,).<br />This setting is deprecated for ARMS agents **V4.0.0 or later**.|""|'."\n" + .'|Inclusion of trace IDs in an HTTP response|profiler.responseInject.enable|boolean|Valid values:<br />\\- `true`: enables the feature<br />\\- `false`: disables the feature|false|', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ImportAppAlertRules' => [ + 'summary' => 'Creates an alert rule based on an alert template.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClusterName', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '仅ClusterType为“ecs”时生效：ecs实例的名称', - 'description' => 'The name of the cluster. This parameter is required if the ClusterType parameter is set to ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prd-ecs', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'ClusterType', + 'name' => 'TemplateAlertId', 'in' => 'query', - 'schema' => [ - 'title' => '可选值：ask、ecs、one、acs、pro、flink', - 'description' => 'The cluster type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* ecs: ECS'."\n" - .'* one: ACK One'."\n" - .'* ask: ASK'."\n" - .'* pro: Container Monitoring Pro'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ecs' => 'ecs', - 'one' => 'one', - 'ask' => 'ask', - 'pro' => '', - ], - 'example' => 'ask', - 'enum' => [ - 'ecs', - 'ask', - 'one', - 'acs', - 'pro', - 'flink', - ], - ], + 'schema' => ['description' => 'The ID of the alert template. You must set at least one of the **TemplateAlertId** and **TemplageAlertConfig** parameters. If you set both parameters, the **TemplateAlertId** parameter prevails.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '324324234', 'title' => ''], ], [ - 'name' => 'VpcId', + 'name' => 'Pids', 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The virtual private cloud (VPC) where the cluster resides.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-xxxxxx', - ], + 'schema' => ['description' => 'The process identifiers (PIDs) of the applications associated with the alert rule. The value must be a JSON array. For more information about how to obtain the PID, see [Obtain the PID of an application](~~186100#section-bkl-3j6-ezg~~).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '["atc889zkcf@d8deedfa9bfxxxx", "acd129bfcf@d5daebfa6cdxxxx"]', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the vSwitch that is used by the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vsw-bp1*********', - ], + 'schema' => ['description' => 'The ID of the region where the associated applications reside.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SecurityGroupId', + 'name' => 'ContactGroupIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the security group to which the cluster belongs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'sg-bp1********', - ], + 'schema' => ['description' => 'The IDs of the alert contact groups. The value must be a JSON array.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[123, 234]', 'title' => ''], ], [ - 'name' => 'GrafanaInstanceId', + 'name' => 'IsAutoStart', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '绑定托管版Grafana工作区Id。为空或“free”时，表示绑定到“共享版Grafana”。', - 'description' => 'The ID of the managed Grafana workspace that is associated with the cluster. If you set this parameter to free or leave this parameter empty, the cluster is associated with a shared Grafana workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'grafana-bp1*****', - 'default' => 'free', - ], + 'schema' => ['description' => 'Specifies whether to enable the alert rule after it is created. Default value: `false`.'."\n" + ."\n" + .'* `true`: enables the alert rule.'."\n" + .'* `false`: disables the alert rule.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'KubeConfig', + 'name' => 'TemplageAlertConfig', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'This parameter is not supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '-', - 'default' => 'kubeConfig', - ], + 'schema' => ['description' => 'The configurations of the alert template based on which you want to create an alert rule. The value must be a JSON string. You must set at least one of the **TemplateAlertId** and **TemplageAlertConfig** parameters. If you set both parameters, the **TemplateAlertId** parameter prevails. For more information about the TemplageAlertConfig parameter, see the following **additional information about the TemplageAlertConfig parameter**.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[ { "contactGroupIds": "381", "alertType": 5, "alarmContext": { "subTitle": "", "content": "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！" }, "alertLevel": "WARN", "metricParam": { "appId": "70901", "pid": "atc889zkcf@d8deedfa9bf****", "type": "TXN", "dimensions": [ { "type": "STATIC", "value": "\\\\/hello_test_api_address\\\\/test1", "key": "rpc" } ] }, "alertWay": [ "SMS", "MAIL", "DING_ROBOT" ], "alertRule": { "rules": [ { "measure": "appstat.txn.rt", "alias": "入口调用响应时间_ms", "aggregates": "AVG", "nValue": 1, "value": 1, "operator": "CURRENT_GTE" } ], "operator": "|" }, "title": "报警模板报警名", "config": "{\\"continuous\\":false,\\"dataRevision\\":2,\\"ownerId\\":\\"123412341234\\"}", "notice": { "noticeStartTime": 1480521600000, "startTime": 1480521600000, "endTime": 1480607940000, "noticeEndTime": 1480607940000 }, "status": "NON" } ]', 'title' => ''], ], [ - 'name' => 'VcExtraInfo', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'type' => 'string', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['type' => 'string', 'required' => false, 'description' => 'The tag key.'."\n", 'example' => 'type', 'title' => ''], + 'Value' => ['type' => 'string', 'required' => false, 'description' => 'The tag value.'."\n", 'example' => 'prod', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, + 'maxItems' => 21, + 'description' => 'The list of tags.'."\n", + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Data' => [ - 'description' => 'The response content. In most cases, the installation status of the Prometheus agent is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the Prometheus agent was installed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message returned if the Prometheus agent failed to be installed.'."\n", - 'type' => 'string', - 'example' => 'vpcId is blank', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Data' => ['description' => 'The ID of the alert rule.'."\n", 'type' => 'string', 'example' => '[12174**]', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[12174**]\\",\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\"\\n}","errorExample":""},{"type":"xml","example":"<ImportAppAlertRulesResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <Data>[12174**]</Data>\\n</ImportAppAlertRulesResponse>","errorExample":""}]', + 'title' => 'ImportAppAlertRules', + 'description' => '> You can call the **ImportAppAlertRules** operation to import only the alert rules that are generated by Application Real-Time Monitoring Service (ARMS) for application monitoring and browser monitoring. This operation cannot be used to import custom alert rules, alert rules for Prometheus monitoring, or default emergency alert rules.'."\n", + 'requestParamsDescription' => '## Additional information about the **TemplageAlertConfig** parameter'."\n" + ."\n" + .'**JSON string example and description**'."\n" + ."\n" + .'```'."\n" + ."\n" + .'['."\n" + .' {'."\n" + ."\n" + .' "contactGroupIds": "381", // The ID of the alert contact group. Multiple IDs are separated by commas (,). You can ignore this parameter in the alert template configuration. The value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" + .' "alertType": 5, // The alert type. Valid values: 4 and 5. A value of 4 indicates browser monitoring. A value of 5 indicates application monitoring. '."\n" + .' "alarmContext": { // The template of the alert notification. '."\n" + .' "subTitle": "",'."\n" + .' "content": "Alert name: $alert name\\nFilter condition: $filter\\nAlert time: $alert time\\nAlert content: $alert content\\nNote: The alert remains being triggered until a reply email is received. The system will remind you 24 hours later."'."\n" + .' },'."\n" + .' "alertLevel": "WARN", // The alert severity. Valid values: FATAL, ERROR, and WARN. '."\n" + .' "metricParam": {'."\n" + .' "appId": "70901", // The ID of the associated application. You can specify an arbitrary value in the alert template configuration. The actual value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" + .' "pid": "atc889zkcf@d8deedfa9bf****", // The PID of the associated application. You can specify an arbitrary value in the alert template configuration. The actual value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" + .' "type": "TXN", // The type of the alert metric. For more information, see the following section. '."\n" + .' "dimensions": [ // The information about the associated dimension. For more information, see the following section. '."\n" + .' {'."\n" + .' "type": "STATIC",'."\n" + .' "value": "\\/hello_test_api_address\\/test1",'."\n" + .' "key": "rpc"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "alertWay": [ // The notification method. Valid values: SMS, MAIL, and DING_ROBOT. '."\n" + .' "SMS",'."\n" + .' "MAIL",'."\n" + .' "DING_ROBOT"'."\n" + .' ],'."\n" + .' "alertRule": {'."\n" + .' "rules": [ // The conditions of the alert rule.'."\n" + .' {'."\n" + .' "measure": "appstat.txn.rt", // The metric based on which alerts are triggered. For more information, see the following section. '."\n" + .' "alias": "the response time of API calls in milliseconds", // The display parameter of the alert metric. You do not need to set this parameter for an alert template. '."\n" + .' "aggregates": "AVG", // The aggregation logic of the alert rule. Valid values: AVG, SUM, MIN, and MAX. '."\n" + .' "nValue": 1, // The time range to query. '."\n" + .' "value": 1, // The threshold of the condition. '."\n" + .' "operator": "CURRENT_GTE" // The operation logic of the condition. Valid values: CURRENT_GTE: greater than or equal to. CURRENT_LTE: less than or equal to. PREVIOUS_UP: the minute-to-minute increase percentage. PREVIOUS_DOWN: the minute-to-minute decrease percentage. HOH_UP: the increase percentage compared with the previous hour. HOH_DOWN: the decrease percentage compared with the previous hour. DOD_UP: the increase percentage compared with the last day. DOD_DOWN: the decrease percentage compared with the last day. '."\n" + .' }'."\n" + .' ],'."\n" + .' "operator": "|" // The logical operator between conditions. Valid values: &: AND. |: OR. '."\n" + .' },'."\n" + .' "title": "Template alert name", // The alert name. An alert rule name in the format of {title}-Application name is generated when ARMS creates the alert rule based on the alert template. '."\n" + .' "config": "{\\"continuous\\":false,\\"dataRevision\\":2,\\"ownerId\\":\\"123412341234\\"}", // If the continuous parameter is set to true, ARMS sends alert notifications without interruption. If the continuous parameter is set to false, an alert silence period of 24 hours is enabled. The dataRevision parameter specifies the data revision policy to be used if no data is obtained or the data is null. Valid values: 0: overwrites the data by using the value 0. 1: overwrites the data by using the value 1. 2: overwrites the data by using the value null, which means that no alert is triggered if no data exists. '."\n" + .' "notice": { // The noticeStartTime and noticeEndTime parameters specify the time range when alert notifications are sent. The startTime and endTime parameters specify the time range when the alert rule takes effect. The values are UNIX timestamps in milliseconds. Each timestamp indicates a point in time on the current day. For example, the 1565964097071 timestamp indicates 22:01:37 on August 16, 2019. '."\n" + .' "noticeStartTime": 1480521600000,'."\n" + .' "startTime": 1480521600000,'."\n" + .' "endTime": 1480607940000,'."\n" + .' "noticeEndTime": 1480607940000'."\n" + .' },'."\n" + .' "status": "NON" // The status of the alert rule. You can ignore this parameter in the alert template configuration. The value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" + .' }'."\n" + .']'."\n" + .' '."\n" + .'```'."\n" + ."\n" + .'**Description of the Measure, Dimension, and metricParam.type parameters**'."\n" + ."\n" + .'The **metricParam.type** parameter specifies the unique type of each alert rule. Each type of alert rules can use a dimension for the conditions. Multiple conditions can be set for each type of alert rules. Each condition can use multiple metrics of the same type for calculation.****'."\n" + ."\n" + .'The **Dimensions.type** parameter has the following valid values:'."\n" + ."\n" + .'* `STATIC`: checks only the value of this dimension. In this case, you must set the **dimensions.value** parameter.'."\n" + .'* `ALL`: checks the values of all dimensions. The metrics of all API operations are checked. If an operation triggers an alert, the operation name is displayed in the alert notification. In this case, you do not need to set the **dimensions.value** parameter.'."\n" + .'* `DISABLE`: aggregates the values of all dimensions. In this case, you do not need to set the **dimensions.value** parameter.'."\n" + ."\n" + .'**Alert metrics**'."\n" + ."\n" + .'* Alert type (metricParam.type): TXN'."\n" + ."\n" + .' * Dimension (dimensions.key): rpc'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.txn.rt: the response time of API calls in milliseconds'."\n" + .' * appstat.txn.count: the number of API calls'."\n" + .' * appstat.txn.errcount: the number of API call errors'."\n" + ."\n" + .'* Alert type (metricParam.type): TXN_TYPE'."\n" + ."\n" + .' * Dimension (dimensions.key): rpcType'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.incall.rt: the response time of API calls for the services that are provided by the application, in milliseconds'."\n" + .' * appstat.incall.count: the number of API calls for the services that are provided by the application'."\n" + .' * appstat.incall.error: the number of API call errors for the services that are provided by the application'."\n" + .' * appstat.outcall.rt: the response time of API calls for the services on which the application depends, in milliseconds'."\n" + .' * appstat.outcall.count: the number of API calls for the services on which the application depends'."\n" + .' * appstat.outcall.error: the number of API call errors for the services on which the application depends'."\n" + ."\n" + .'* Alert type (metricParam.type): DB'."\n" + ."\n" + .' * Dimension (dimensions.key): endpoint'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.database.rt: the response time of API calls for the database'."\n" + .' * appstat.database.count: the number of API calls for the database'."\n" + .' * appstat.database.errcount: the number of API call errors for the database'."\n" + ."\n" + .'* Alert type (metricParam.type): JVM'."\n" + ."\n" + .' * Dimension (dimensions.key): rootIp'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.jvm.heap_used: the total memory space in the JVM heap, in bytes'."\n" + .' * appstat.jvm.GcPsScavengeCount: the number of garbage collections (GCs) in JVM'."\n" + .' * appstat.jvm.GcPsMarkSweepCount: the number of tag deletions in JVM'."\n" + .' * appstat.jvm.GcG1OldGenCount: the number of Garbage-First (G1) GCs in the old generation'."\n" + .' * appstat.jvm.GcG1YoungGenCount: the number of G1 GCs in the young generation'."\n" + .' * appstat.jvm.gc.YoungGcCountInstant: the number of GCs in the young generation'."\n" + .' * appstat.jvm.gc.OldGcCountInstant: the number of full heap GCs (Full GCs) in JVM'."\n" + .' * appstat.jvm.gc.YoungGcTimeInstant: the time that is consumed for the GCs in the young generation, in milliseconds'."\n" + .' * appstat.jvm.gc.OldGcTimeInstant: the time that is consumed for the Full GCs in JVM, in milliseconds'."\n" + .' * appstat.jvm.ThreadCount: the total number of JVM threads'."\n" + .' * appstat.jvm.non_heap_used: the used space of the non-heap JVM memory, in bytes'."\n" + .' * appstat.jvm.non_heap_max: the maximum space of the non-heap JVM memory, in bytes'."\n" + .' * appstat.jvm.non_heap_init: the initial space of the non-heap JVM memory, in bytes'."\n" + .' * appstat.jvm.non_heap_committed: the submitted space of the non-heap JVM memory, in bytes'."\n" + ."\n" + .'* Alert type (metricParam.type): HOST'."\n" + ."\n" + .' * Dimension (dimensions.key): rootIp'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.jvm.SystemCpuUser: the used CPU of the host, in percentage'."\n" + .' * appstat.jvm.SystemMemFree: the idle memory space of the host, in bytes'."\n" + .' * appstat.jvm.SystemDiskFree: the idle disk space of the host, in bytes'."\n" + .' * appstat.jvm.SystemNetInErrs: the number of error messages that is received by the host'."\n" + .' * appstat.jvm.SystemNetOutErrs: the number of error messages that is sent by the host'."\n" + .' * appstat.jvm.SystemLoad: the system load of the host'."\n" + ."\n" + .'* Alert type (metricParam.type): EXCEPTION'."\n" + ."\n" + .' * Dimension (dimensions.key): rpc'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.exception.rt: the response time of abnormal API calls for the application, in milliseconds'."\n" + .' * appstat.exception.count: the number of abnormal API calls for the application'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-14T01:53:12.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"String\\\\t2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Data\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"vpcId is blank\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'InstallManagedPrometheus', - 'description' => 'You can call this operation only if the following conditions are met: The resources that you want to monitor are ASK clusters or ECS clusters. No Prometheus agents are installed in the ASK or ECS clusters. Take note that Prometheus agents can be installed only on the cloud service side, not in user clusters.'."\n", + 'ramActions' => [], ], - 'UninstallManagedPrometheus' => [ - 'summary' => 'Uninstalls a managed Prometheus agent for a serverless Kubernetes (ASK) cluster, Distributed Cloud Container Platform for Kubernetes (ACK One) cluster, or Elastic Compute Service (ECS) cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InitEnvironment' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '119001', - 'abilityTreeNodes' => [ - 'FEATUREarmsC7S24K', - ], - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'ClusterType为“ask”时，必填。', - 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster. This parameter is required when the ClusterType parameter is set to ask or one.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The language. Valid values: zh and en. Default: zh.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例的资源组id', - 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The ID of the environment instance.', 'type' => 'string', 'required' => true, 'example' => 'env-xxx', 'title' => ''], ], [ - 'name' => 'ClusterType', + 'name' => 'ManagedType', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'title' => '可选值：ask、ecs、one、acs、flink', - 'description' => 'The cluster type. Valid values: ask, ecs, and one.'."\n", + 'description' => 'The agent management mode. Valid values:'."\n" + ."\n" + .'- none: unmanaged. Default for ACK clusters.'."\n" + ."\n" + .'- agent: managed agents only. Default for ASK, ACS, and ACK One clusters.'."\n" + ."\n" + .'- agent-exproter: managed agents and exporters. Default for cloud services.', 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'ecs' => 'ecs', - 'one' => 'one', - 'ask' => 'ask', - ], - 'example' => 'ask', - 'enum' => [ - 'ecs', - 'ask', - 'one', - 'acs', - 'flink', - ], + 'required' => false, + 'docRequired' => false, + 'enum' => ['none', 'agent', 'agent-exporter'], + 'title' => '', + 'example' => 'agent', ], ], [ - 'name' => 'VpcId', + 'name' => 'CreateAuthToken', 'in' => 'query', 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The ID of the virtual private cloud (VPC) where the cluster resides.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-rpn**********', - ], + 'schema' => ['description' => 'Whether to create an authentication token for enhanced data security.', 'type' => 'boolean', 'docRequired' => false, 'title' => '', 'required' => false, 'example' => 'false'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response object.'."\n", + 'title' => '', + 'description' => 'The response structure.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Data' => [ - 'description' => 'The response content. The status of the Prometheus instance is returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the Prometheus instance was removed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The error message that is returned if the request fails.'."\n", - 'type' => 'string', - 'example' => 'vpcId is blank', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****'], + 'Code' => ['description' => 'The HTTP status code. 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The operation result.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Message' => ['description' => 'The response message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'InitEnvironment', + 'summary' => 'Initializes an environment instance.', + 'changeSet' => [ + ['createdAt' => '2024-04-03T10:34:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-16T09:21:00.000Z', 'description' => 'Request parameters changed'], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitEnvironment'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Data\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"vpcId is blank\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'UninstallManagedPrometheus', - 'description' => 'This operation is available only for ASK, ECS, and ACK One clusters. Before you call this operation, make sure that a managed Prometheus agent is installed for your cluster.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'GetManagedPrometheusStatus' => [ - 'summary' => 'Queries the installation status of a Prometheus agent in a serverless Kubernetes (ASK) cluster or an Elastic Compute Service (ECS) cluster.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InstallAddon' => [ + 'summary' => 'Installs an add-on.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the add-on.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'mysql'], ], [ - 'name' => 'ClusterId', + 'name' => 'AddonVersion', 'in' => 'query', - 'schema' => [ - 'title' => 'ClusterType为“ask”时，必填。', - 'description' => 'The cluster ID. This parameter is required if the ClusterType parameter is set to ask.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The version of the add-on.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => '0.0.1'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例的资源组id', - 'description' => 'The resource group id of the Prometheus instance.', - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The language. Valid values: zh and en. Default value: zh.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'ClusterType', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '可选值：ask、ecs、one、acs', - 'description' => 'The type of the cluster. Valid values: ask and ecs.'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'acs' => 'acs', - 'ecs' => 'ecs', - 'one' => 'one', - 'ask' => 'ask', - ], - 'example' => 'ask', - ], + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-xxx'], ], [ - 'name' => 'VpcId', + 'name' => 'Values', 'in' => 'query', - 'schema' => [ - 'title' => 'ClusterType为“ecs”时，必填。', - 'description' => 'The ID of the virtual private cloud (VPC). This parameter is required if the ClusterType parameter is set to ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-***', - ], + 'schema' => ['description' => 'The metadata.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}'], + ], + [ + 'name' => 'ReleaseName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the add-on after it is installed. If you do not specify this parameter, a default rule name is generated.', 'type' => 'string', 'required' => false, 'example' => 'mysql-xxxxx', 'title' => ''], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to perform only a dry run, without performing the actual request. Default value: false.', 'type' => 'boolean', 'title' => '', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response format.'."\n", + 'description' => 'response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => 'The installation status of the Prometheus agent.'."\n" - ."\n" - .'* Installing: The Prometheus agent is installed and no registration information is available.'."\n" - .'* Succeed: The Prometheus agent is installed and registered.'."\n" - .'* Failure: The Prometheus agent failed to be installed or registered.'."\n" - .'* Unknown: The installation status of the Prometheus agent is unknown.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Unknown' => 'Unknown', - 'Installing' => 'Installing', - 'Failure' => 'Failure', - 'Succeed' => 'Succeed', - ], - 'example' => 'Installing', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'Successful'."\n", - ], - 'Code' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'AddonName' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'AlertRuleCount' => ['description' => 'The number of alert rules.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Conditions' => [ + 'description' => 'The installation phase.', + 'type' => 'array', + 'items' => [ + 'description' => 'Condition information.', + 'type' => 'object', + 'properties' => [ + 'FirstTransitionTime' => ['description' => 'The first transition time.', 'type' => 'string', 'example' => '2018-01-31T14:32:19Z', 'title' => ''], + 'LastTransitionTime' => ['description' => 'The last transition time.', 'type' => 'string', 'example' => '2018-01-31T14:32:19Z', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Reason' => ['description' => 'The reason for the failure.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Status' => ['description' => 'The status of the phase.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'Type' => ['description' => 'The type of the phase.', 'type' => 'string', 'example' => 'Loaded', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The time when the add-on was created.', 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'DashboardCount' => ['description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExporterCount' => ['description' => 'The number of exporters.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'HaveConfig' => ['description' => 'Indicates whether the configuration is available.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'InstallUserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '123456', 'title' => ''], + 'Language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'ReleaseId' => ['description' => 'The release ID after installation.', 'type' => 'string', 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', 'title' => ''], + 'ReleaseName' => ['description' => 'The name of the release.', 'type' => 'string', 'example' => 'mysql-1695372983039', 'title' => ''], + 'Scene' => ['description' => 'The scenario.', 'type' => 'string', 'example' => 'database', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the add-on was updated.', 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'Version' => ['description' => 'The version of the add-on.', 'type' => 'string', 'example' => '0.0.1', 'title' => ''], + 'EnvironmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => 'env-xxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'Managed' => ['description' => 'Indicates whether the component is fully managed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'InstallAddon', + 'changeSet' => [ + ['createdAt' => '2024-01-23T08:07:33.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallAddon'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Data\\": \\"Installing\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"查询成功\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'GetManagedPrometheusStatus', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"AddonName\\": \\"mysql\\",\\n \\"AlertRuleCount\\": 1,\\n \\"Conditions\\": [\\n {\\n \\"FirstTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"LastTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Reason\\": \\"xxxx\\",\\n \\"Status\\": \\"True\\",\\n \\"Type\\": \\"Loaded\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"DashboardCount\\": 1,\\n \\"ExporterCount\\": 2,\\n \\"HaveConfig\\": true,\\n \\"InstallUserId\\": \\"123456\\",\\n \\"Language\\": \\"zh\\",\\n \\"ReleaseId\\": \\"be29c093-3fd6-4fb6-9430-797030cc183a\\",\\n \\"ReleaseName\\": \\"mysql-1695372983039\\",\\n \\"Scene\\": \\"database\\",\\n \\"Status\\": \\"0\\",\\n \\"UpdateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"UserId\\": \\"111\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-heyuan\\",\\n \\"Managed\\": true\\n }\\n}","type":"json"}]', ], - 'BindPrometheusGrafanaInstance' => [ - 'summary' => 'Binds a Grafana workspace to a Prometheus instance.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InstallCmsExporter' => [ + 'summary' => 'Installs the cms-exporter collector.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -22864,174 +18066,136 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-beijing', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例Id', - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'CmsArgs', 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例的资源组id', - 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['title' => '', 'description' => 'The cloud services that you want to monitor. The CmsArgs parameter is the startup parameter of the cms-exporter collector. Separate multiple cloud services with number signs (`#`).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'hologres#cen'], ], [ - 'name' => 'GrafanaInstanceId', + 'name' => 'EnableTag', 'in' => 'query', - 'schema' => [ - 'title' => 'grafana工作区id', - 'description' => 'The ID of the Grafana workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'grafana-bp1*****', - ], + 'schema' => ['description' => 'Specifies whether to collect the aliyun tags attached to each cloud service. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'false', 'default' => 'true', 'title' => ''], + ], + [ + 'name' => 'DirectArgs', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The recently monitored cloud services. Separate multiple cloud services with number signs (`#`).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'hologres#cen'], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - 'Data' => [ - 'title' => '操作是否成功', - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'enumValueTitles' => [ - 'true' => '', - 'false' => '', - ], - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request. You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1'], + 'Data' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], - ], - ], - ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', + 'example' => '', ], ], ], 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'substitutions' => ['ARMS::2019-08-08::InstallAddon'], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": true,\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'BindPrometheusGrafanaInstance', - ], - 'AddPrometheusIntegration' => [ - 'summary' => 'Adds an exporter to a Prometheus instance for Container Service or a Prometheus instance for ECS.', - 'methods' => [ - 'post', - 'get', + 'title' => 'InstallCmsExporter', + 'changeSet' => [ + ['createdAt' => '2022-06-16T06:18:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-04-22T09:39:44.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallCmsExporter'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + ], + 'InstallEnvironmentFeature' => [ + 'summary' => 'Installs a feature.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => 'region id', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'ClusterId', + 'name' => 'FeatureName', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.'."\n", + 'title' => '', + 'description' => 'The name of the feature.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* app-agent-pilot'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'* metric-agent'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", 'type' => 'string', 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + 'enumValueTitles' => ['app-agent-pilot' => 'Agent of app-pilot', 'metric-agent' => 'Agent of metric collection'], + 'example' => 'metric-agent', ], ], [ - 'name' => 'IntegrationType', + 'name' => 'FeatureVersion', 'in' => 'query', - 'schema' => [ - 'title' => 'Prometheus集成类型', - 'description' => 'The type of the integration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'kafka, mysql, redis, snmp, emr, nubela, and tidb'."\n", - ], + 'schema' => ['title' => '', 'description' => 'The version of the feature.'."\n", 'type' => 'string', 'required' => true, 'example' => '1.1.17'], ], [ - 'name' => 'Param', + 'name' => 'Config', 'in' => 'query', - 'schema' => [ - 'title' => 'Prometheus集成配置参数json串', - 'description' => 'The configurations of the exporter. The value is a JSON string.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{"port":"5554","name":"kafka-test12","kafka_instance":"kafka-test","__label_value":"kafka-test","scrape_interval":33,"metrics_path":"/metrics","__label_key":"kafka-test"}', - ], + 'schema' => ['title' => '', 'description' => 'The metadata of the feature.'."\n", 'type' => 'string', 'required' => false, 'example' => '{\\"continuous\\":true,\\"dataRevision\\":2}'], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The region ID of the feature.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen'], ], ], 'responses' => [ @@ -23041,68 +18205,34 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '3703B98C-335E-5BA7-972E-F90E9E768A85', - ], - 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The ID of the exporter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2829', - ], - 'InstanceName' => [ - 'title' => 'prometheus集成的实例名', - 'description' => 'The name of the exporter.'."\n", - 'type' => 'string', - 'example' => 'hw-cloud02', - ], - ], - ], - 'Code' => [ - 'description' => 'The status code or error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The release ID.'."\n", 'type' => 'string', 'example' => '83FCC44C-A056-18AF-A902-7043E723F0D9', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"83FCC44C-A056-18AF-A902-7043E723F0D9\\"\\n}","type":"json"}]', + 'title' => 'InstallEnvironmentFeature', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallEnvironmentFeature'], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"3703B98C-335E-5BA7-972E-F90E9E768A85\\",\\n \\"Data\\": {\\n \\"InstanceId\\": 2829,\\n \\"InstanceName\\": \\"hw-cloud02\\"\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'AddPrometheusIntegration', + 'ramActions' => [], ], - 'UpdatePrometheusIntegration' => [ - 'summary' => 'Modifies the configurations of an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'InstallManagedPrometheus' => [ + 'summary' => 'Create a managed (ASK/ECS) Prometheus instance. ', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23112,655 +18242,637 @@ 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '118951', + 'abilityTreeNodes' => ['FEATUREarmsC7S24K'], ], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the ASK cluster.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], ], [ - 'name' => 'Param', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => 'Prometheus集成配置参数json串', - 'description' => 'The configurations of the exporter. The value is a JSON string.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{'."\n" - .' "port": "5554",'."\n" - .' "name": "kafka-test12",'."\n" - .' "kafka_instance": "kafka-test",'."\n" - .' "__label_value": "kafka-test",'."\n" - .' "scrape_interval": 33,'."\n" - .' "metrics_path": "/metrics",'."\n" - .' "__label_key": "kafka-test"'."\n" - .'}', - ], + 'schema' => ['title' => '', 'description' => 'Resource group ID of the Prometheus instance. ', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****'], ], [ - 'name' => 'InstanceId', + 'name' => 'ClusterName', 'in' => 'query', - 'schema' => [ - 'description' => 'The exporter ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2893', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The name of the cluster. This parameter is required if the ClusterType parameter is set to ecs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'prd-ecs'], ], [ - 'name' => 'IntegrationType', + 'name' => 'ClusterType', 'in' => 'query', 'schema' => [ - 'title' => 'prometheus集成类型', - 'description' => 'The type of the integration.'."\n", + 'title' => '', + 'description' => 'The cluster type.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* ecs: ECS'."\n" + .'* one: ACK One'."\n" + .'* ask: ASK'."\n" + .'* pro: Container Monitoring Pro'."\n", 'type' => 'string', 'required' => true, - 'example' => 'kafka, mysql, redis, snmp, emr, nubela, and tidb'."\n", + 'docRequired' => true, + 'enumValueTitles' => ['ecs' => 'ecs', 'one' => 'one', 'ask' => 'ask', 'pro' => ''], + 'example' => 'ask', + 'enum' => ['ecs', 'ask', 'one', 'acs', 'pro', 'flink'], ], ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The virtual private cloud (VPC) where the cluster resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vpc-xxxxxx'], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the vSwitch that is used by the cluster.'."\n", 'type' => 'string', 'required' => true, 'example' => 'vsw-bp1*********', 'title' => ''], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the security group to which the cluster belongs.'."\n", 'type' => 'string', 'required' => true, 'example' => 'sg-bp1********', 'title' => ''], + ], + [ + 'name' => 'GrafanaInstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The ID of the managed Grafana workspace that is associated with the cluster. If you set this parameter to free or leave this parameter empty, the cluster is associated with a shared Grafana workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => 'grafana-bp1*****', 'default' => 'free'], + ], + [ + 'name' => 'KubeConfig', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'This parameter is not supported.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '-', 'default' => 'kubeConfig', 'title' => ''], + ], + [ + 'name' => 'VcExtraInfo', + 'in' => 'query', + 'schema' => ['type' => 'string', 'required' => false, 'description' => 'Extension information for the Flink VC cluster. ', 'example' => '-', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2DB771C3-D1BB-5363-8A5F-ADB2AF2948DB', - ], - 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'InstanceId' => [ - 'description' => 'The exporter ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2866', - ], - 'InstanceName' => [ - 'title' => 'prometheus集成的实例名', - 'description' => 'The exporter name.'."\n", - 'type' => 'string', - 'example' => 'inet', - ], - ], - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'Successful'."\n", - ], - 'Code' => [ - 'description' => 'The status code or error code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Data' => ['description' => 'The response content. In most cases, the installation status of the Prometheus agent is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the Prometheus agent was installed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the Prometheus agent failed to be installed.'."\n", 'type' => 'string', 'example' => 'vpcId is blank', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], - ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DB771C3-D1BB-5363-8A5F-ADB2AF2948DB\\",\\n \\"Data\\": {\\n \\"InstanceId\\": 2866,\\n \\"InstanceName\\": \\"inet\\"\\n },\\n \\"Message\\": \\"查询成功\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'UpdatePrometheusIntegration', + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], + ], + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'title' => 'Create Managed Prometheus ', + 'description' => 'This applies only to ASK and ECS instances, and only if Alibaba Cloud Prometheus has not been previously installed on the cluster. The managed Prometheus instance will be installed on the cloud service side and will not be visible within the user\'s cluster. ', + 'changeSet' => [ + ['createdAt' => '2025-03-13T02:36:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-01-10T10:15:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-03T06:47:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-10T02:12:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-15T03:15:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-02T07:40:23.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-28T11:41:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-11-28T11:41:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-10T06:32:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-10T06:32:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-04T08:46:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-04T07:21:29.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallManagedPrometheus'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"String\\\\t2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Data\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"vpcId is blank\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'translator' => 'machine', ], - 'DeletePrometheusIntegration' => [ - 'summary' => 'Deletes an exporter from a Prometheus instance for Container Service or a Prometheus instance for ECS.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListActivatedAlerts' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => true, + 'operationType' => 'read', + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '44476', + 'abilityTreeNodes' => ['FEATUREarmsK5DKZM'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Filter', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The filter condition in the `{"key":"value"}`format. You must specify the `key` and `value` of the filter condition.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '{"alertname":"容器CPU使用率大于80%"}', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou ', 'title' => ''], ], [ - 'name' => 'IntegrationType', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus集成类型，如kafka、mysql', - 'description' => 'The type of the integration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'kafka and mysql.'."\n", - ], + 'schema' => ['description' => 'The number of the page to return. Default value: `1`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'InstanceId', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the exporter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2875', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: `10`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => true, 'docRequired' => true, 'example' => '10', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '19F54318-CC92-5567-BF66-CB029EC44C84', - ], - 'Data' => [ - 'title' => '”success“或失败信息。', - 'description' => 'success or an error message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'BDB74B8F-4123-482A-ABB7-7F440349****', 'title' => ''], + 'Page' => [ + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Page' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Alerts' => [ + 'description' => 'The alerts that have been triggered.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'* `Active`'."\n" + .'* `Inhibited`'."\n" + .'* `Silenced`'."\n" + .'* `Resolved`'."\n", 'type' => 'string', 'example' => 'Active', 'title' => ''], + 'Severity' => ['description' => 'The level of the alert. Valid values:'."\n" + ."\n" + .'* `critical`'."\n" + .'* `error`'."\n" + .'* `warn`'."\n" + .'* `page`'."\n", 'type' => 'string', 'example' => 'critical', 'title' => ''], + 'IntegrationName' => ['description' => 'The name of the object that is associated with the alert.'."\n", 'type' => 'string', 'example' => 'testphp2', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp when the alert rule was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1616466300000', 'title' => ''], + 'Message' => ['description' => 'The description of the alert.'."\n", 'type' => 'string', 'example' => '报警名称：PodRestart_testphp2，\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%', 'title' => ''], + 'AlertType' => ['description' => 'The type of the alert.'."\n", 'type' => 'string', 'example' => 'ARMS-Prometheus监控', 'title' => ''], + 'InvolvedObjectName' => ['description' => 'The name of the service integration that generated the alert.'."\n", 'type' => 'string', 'example' => '测试集成-prometheus', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'example' => '容器CPU使用率大于80%', 'title' => ''], + 'Count' => ['description' => 'The number of times that the alert event was received.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '598', 'title' => ''], + 'ExpandFields' => ['description' => 'The extended fields that indicate the following tags:'."\n" + ."\n" + .'* The tags that are carried in the metrics of the alert rule expression.'."\n" + .'* The tags that are created based on the alert rule.'."\n" + .'* The default tags of Application Real-Time Monitoring Service (ARMS).'."\n", 'type' => 'object', 'example' => ' "severity": "critical", "_aliyun_arms_alert_level": "ERROR", "pod": "night-test-group-1-1-5f5d6f4d84-pszns", "_aliyun_arms_alert_type": "101", "_aliyun_arms_integration_name": "测试集成-prometheus", "alertname": "PodRestart_jiubiantestphp2", "_aliyun_arms_userid": "1131971649496228", "_aliyun_arms_involvedObject_name": "jiubiantestphp2", "_aliyun_arms_involvedObject_id": "ccafb2763cfa7415eb2e2a60a74b1f825", "_aliyun_arms_region_id": "cn-beijing", "_aliyun_arms_involvedObject_kind": "cluster", "_aliyun_arms_product_type": "PROMETHEUS", "namespace": "default", "_aliyun_arms_integration_id": "80", "_aliyun_arms_involvedObject_type": "ManagedKubernetes", "_aliyun_arms_alert_rule_id": "3612229"', 'title' => ''], + 'EndsAt' => ['description' => 'The timestamp when the alert was ended.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1616502540000', 'title' => ''], + 'InvolvedObjectKind' => ['description' => 'The type of the object that is associated with the alert.'."\n", 'type' => 'string', 'example' => 'cluster', 'title' => ''], + 'IntegrationType' => ['description' => 'The type of the service integration that generated the alert.'."\n", 'type' => 'string', 'example' => 'PROMETHEUS', 'title' => ''], + 'StartsAt' => ['description' => 'The timestamp when the alert was generated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1616466300000', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule.'."\n", 'type' => 'string', 'example' => '3888704', 'title' => ''], + 'DispatchRules' => [ + 'description' => 'The notification policies.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleId' => ['description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '7021', 'title' => ''], + 'RuleName' => ['description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => '容器CPU使用率大于80%的通知策略', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The error message returned when the invocation fails. ', 'type' => 'string', 'example' => 'CurrentPage is mandatory for this action.', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"BDB74B8F-4123-482A-ABB7-7F440349****\\",\\n \\"Page\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 5,\\n \\"Page\\": 1,\\n \\"Alerts\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"Severity\\": \\"critical\\",\\n \\"IntegrationName\\": \\"testphp2\\",\\n \\"CreateTime\\": 1616466300000,\\n \\"Message\\": \\"报警名称：PodRestart_testphp2，\\\\\\\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%\\",\\n \\"AlertType\\": \\"ARMS-Prometheus监控\\",\\n \\"InvolvedObjectName\\": \\"测试集成-prometheus\\",\\n \\"AlertName\\": \\"容器CPU使用率大于80%\\",\\n \\"Count\\": 598,\\n \\"ExpandFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EndsAt\\": 1616502540000,\\n \\"InvolvedObjectKind\\": \\"cluster\\",\\n \\"IntegrationType\\": \\"PROMETHEUS\\",\\n \\"StartsAt\\": 1616466300000,\\n \\"AlertId\\": \\"3888704\\",\\n \\"DispatchRules\\": [\\n {\\n \\"RuleId\\": 7021,\\n \\"RuleName\\": \\"容器CPU使用率大于80%的通知策略\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"CurrentPage is mandatory for this action.\\"\\n}","type":"json"}]', + 'title' => 'Query the list of triggered alerts', + 'summary' => 'Invoke the ListActivatedAlerts API to query the list of triggered alerts. ', + 'description' => 'This API is no longer maintained. Use the ListAlerts API of the new alert management system to query the alert sending history. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-08-26T05:55:55.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-06-21T08:17:47.000Z', 'description' => 'Error codes changed'], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"19F54318-CC92-5567-BF66-CB029EC44C84\\",\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'DeletePrometheusIntegration', + 'ramActions' => [], + 'translator' => 'machine', ], - 'GetPrometheusIntegration' => [ - 'summary' => 'Queries the information about an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAddonReleases' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, + 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191179', + 'abilityTreeNodes' => ['FEATUREarms7LDEBN'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], [ - 'name' => 'ClusterId', + 'name' => 'AddonName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance. Valid values: aliyun-cs and ecs.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['title' => '', 'description' => 'The name of the addon.', 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ - 'name' => 'IntegrationType', - 'in' => 'query', - 'schema' => [ - 'title' => 'Prometheus集成类型', - 'description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'kafka, mysql, redis, snmp, emr, nubela, and tidb'."\n", - ], - ], - [ - 'name' => 'InstanceId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the exporter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '2893', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response schema.'."\n", + 'description' => 'response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9BEF2832-9D95-5E3E-9B10-74887CA17B94', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****'], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the query was successful. Valid values:'."\n" + .'- true: Successful.'."\n" + .'- false: Failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ - 'ClusterId' => [ + 'Releases' => [ + 'description' => 'The collection of addon releases.', + 'type' => 'array', + 'items' => [ + 'description' => 'The collection of addon releases.', + 'type' => 'object', + 'properties' => [ + 'AddonName' => ['description' => 'The component name.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'AlertRuleCount' => ['description' => 'The number of alert groups.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Conditions' => [ + 'description' => 'The installation phases.', + 'type' => 'array', + 'items' => [ + 'description' => 'The phase information.', + 'type' => 'object', + 'properties' => [ + 'FirstTransitionTime' => ['description' => 'The time of the first transition.', 'type' => 'string', 'example' => '2018-01-31T14:32:19Z', 'title' => ''], + 'LastTransitionTime' => ['description' => 'The time of the last transition.', 'type' => 'string', 'example' => '2018-01-31T14:32:19Z', 'title' => ''], + 'Message' => ['description' => 'The detailed information.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Reason' => ['description' => 'The failure reason.', 'type' => 'string', 'example' => 'xxxx', 'title' => ''], + 'Status' => ['description' => 'The phase status.', 'type' => 'string', 'example' => 'True', 'title' => ''], + 'Type' => ['description' => 'The phase type.', 'type' => 'string', 'example' => 'Loaded', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'CreateTime' => ['description' => 'The creation time.', 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'DashboardCount' => ['description' => 'The number of dashboards.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ExporterCount' => ['description' => 'The number of plug-ins.', 'type' => 'integer', 'format' => 'int64', 'example' => '2', 'title' => ''], + 'HaveConfig' => ['description' => 'Indicates whether the addon has configurations.', 'type' => 'boolean', 'example' => 'true'."\n", 'title' => ''], + 'InstallUserId' => ['description' => 'The user ID of the installer.', 'type' => 'string', 'example' => '1268790592387', 'title' => ''], + 'Language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'ReleaseId' => ['description' => 'The release ID after installation.', 'type' => 'string', 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', 'title' => ''], + 'ReleaseName' => ['description' => 'The name of the release.', 'type' => 'string', 'example' => 'mysql-1695372983039', 'title' => ''], + 'Scene' => ['description' => 'The identified scenario.', 'type' => 'string', 'example' => 'database', 'title' => ''], + 'Status' => ['description' => 'The status.', 'type' => 'string', 'example' => '0', 'title' => ''], + 'UpdateTime' => ['description' => 'The update time.', 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '111', 'title' => ''], + 'Version' => ['description' => 'The addon version.', 'type' => 'string', 'example' => '0.0.1', 'title' => ''], + 'EnvironmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => 'env-xxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-heyuan', 'title' => ''], + 'Managed' => ['description' => 'Indicates whether the component is managed.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'NextVersion' => ['description' => 'The latest version.', 'type' => 'string', 'example' => '0.0.4', 'title' => ''], + 'Config' => ['description' => 'The configuration of the addon release.', 'type' => 'string', 'example' => '{"port":"9379"}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], 'title' => '', - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', - ], - 'InstanceId' => [ - 'description' => 'The ID of the exporter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2893', - ], - 'ShowDescribe' => [ - 'description' => 'Indicates whether the description is displayed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NeedUpgrade' => [ - 'description' => 'Indicates whether an upgrade is required.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'InstanceName' => [ - 'description' => 'The name of the exporter.'."\n", - 'type' => 'string', - 'example' => 'lpd-skyeye', - ], - 'IntegrationType' => [ - 'title' => '集成类型', - 'description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", - 'type' => 'string', - 'example' => 'tidb', - ], - 'ExporterType' => [ - 'title' => '集成类型', - 'description' => 'The type of the exporter.'."\n", - 'type' => 'string', - 'example' => 'tidb-exporter', - ], - 'Version' => [ - 'description' => 'The version information.'."\n", - 'type' => 'string', - 'example' => '1.0.0', - ], - 'Target' => [ - 'description' => 'The monitored IP address.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1:3422', - ], - 'CanDelete' => [ - 'description' => 'Indicates whether the exporter can be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CanEditor' => [ - 'description' => 'Indicates whether the exporter can be modified.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => 'The status of the exporter.'."\n", - 'type' => 'string', - 'example' => 'installed', - ], - 'Describe' => [ - 'description' => 'The description of the exporter.'."\n", - 'type' => 'string', - 'example' => '"{}"', - ], - 'ShowLog' => [ - 'description' => 'Indicates whether the exporter logs are displayed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'ContainerName' => [ - 'description' => 'The container name.'."\n", - 'type' => 'string', - 'example' => 'kafka-exporter-1', - ], - 'Param' => [ - 'title' => 'exporter配置参数json串', - 'description' => 'The parameters of the exporter. Format: JSON string.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "port": "5554",'."\n" - .' "name": "kafka-test12",'."\n" - .' "kafka_instance": "kafka-test",'."\n" - .' "__label_value": "kafka-test",'."\n" - .' "scrape_interval": 33,'."\n" - .' "metrics_path": "/metrics",'."\n" - .' "__label_key": "kafka-test"'."\n" - .'}', + 'example' => '', ], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + 'ContainsV2Addon' => ['type' => 'boolean', 'description' => '', 'title' => '', 'example' => ''], ], - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'IdempotentParameterMismatch', - 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query addons installed in an environment', + 'summary' => 'Queries the addons installed in an environment.', + 'changeSet' => [ + ['createdAt' => '2025-01-21T08:48:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-01-23T08:07:33.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddonReleases'], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListAddonReleases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9BEF2832-9D95-5E3E-9B10-74887C******\\",\\n \\"Data\\": {\\n \\"ClusterId\\": \\"cc7a37ee31aea4ed1a059eff8034b****\\",\\n \\"InstanceId\\": 0,\\n \\"ShowDescribe\\": true,\\n \\"NeedUpgrade\\": true,\\n \\"InstanceName\\": \\"lpd-skyeye\\",\\n \\"IntegrationType\\": \\"tidb\\",\\n \\"ExporterType\\": \\"tidb-exporter\\",\\n \\"Version\\": \\"1.0.0\\",\\n \\"Target\\": \\"127.0.XX.XX:3422\\",\\n \\"CanDelete\\": true,\\n \\"CanEditor\\": true,\\n \\"Status\\": \\"installed\\",\\n \\"Describe\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"ShowLog\\": \\"true\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"ContainerName\\": \\"kafka-exporter-1\\",\\n \\"Param\\": \\"{\\\\n \\\\\\"port\\\\\\": \\\\\\"5554\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"kafka-test12\\\\\\",\\\\n \\\\\\"kafka_instance\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"__label_value\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"scrape_interval\\\\\\": 33,\\\\n \\\\\\"metrics_path\\\\\\": \\\\\\"/metrics\\\\\\",\\\\n \\\\\\"__label_key\\\\\\": \\\\\\"kafka-test\\\\\\"\\\\n}\\"\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'GetPrometheusIntegration', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Releases\\": [\\n {\\n \\"AddonName\\": \\"mysql\\",\\n \\"AlertRuleCount\\": 1,\\n \\"Conditions\\": [\\n {\\n \\"FirstTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"LastTransitionTime\\": \\"2018-01-31T14:32:19Z\\",\\n \\"Message\\": \\"xxxx\\",\\n \\"Reason\\": \\"xxxx\\",\\n \\"Status\\": \\"True\\",\\n \\"Type\\": \\"Loaded\\"\\n }\\n ],\\n \\"CreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"DashboardCount\\": 1,\\n \\"ExporterCount\\": 2,\\n \\"HaveConfig\\": true,\\n \\"InstallUserId\\": \\"1268790592387\\",\\n \\"Language\\": \\"zh\\",\\n \\"ReleaseId\\": \\"be29c093-3fd6-4fb6-9430-797030cc183a\\",\\n \\"ReleaseName\\": \\"mysql-1695372983039\\",\\n \\"Scene\\": \\"database\\",\\n \\"Status\\": \\"0\\",\\n \\"UpdateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"UserId\\": \\"111\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-heyuan\\",\\n \\"Managed\\": false,\\n \\"NextVersion\\": \\"0.0.4\\",\\n \\"Config\\": \\"{\\\\\\"port\\\\\\":\\\\\\"9379\\\\\\"}\\"\\n }\\n ],\\n \\"Total\\": 12,\\n \\"ContainsV2Addon\\": false\\n }\\n}","type":"json"}]', ], - 'ListPrometheusIntegration' => [ - 'summary' => 'Queries a list of exporters that are integrated into a Prometheus instance. Only aliyun-cs and ecs instances are supported.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListAddons' => [ + 'summary' => 'List of access center products.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'read', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Search', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance. Only aliyun-cs and ecs instances are supported.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c77f6f2397ea74672872acf5e31374a27', - ], + 'schema' => ['title' => '', 'description' => 'A query field can be queried by name or description.', 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ - 'name' => 'IntegrationType', + 'name' => 'Regexp', 'in' => 'query', - 'schema' => [ - 'description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'kafka, mysql, redis, snmp, emr, nubela, and tidb'."\n", - ], + 'schema' => ['title' => '', 'description' => 'Whether to enable regular matching.', 'type' => 'boolean', 'required' => false, 'example' => 'false'], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Language,the default language is Chinese.', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Category filter.', 'type' => 'string', 'required' => false, 'example' => 'database'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1F1D8840-5330-5804-A8DB-C3C5C5CED6BB', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'Code' => ['title' => '', 'description' => 'Status code: 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200'], + 'Message' => ['title' => '', 'description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success'], + 'Success' => ['title' => '', 'description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" + ."\n" + .'* `true`: The alert rule was deleted.'."\n" + .'* `false`: The alert rule failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true'], 'Data' => [ - 'description' => 'The queried exporters.'."\n", + 'description' => 'The queried add-ons.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The details of the add-on.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', - ], - 'ShowDescribe' => [ - 'description' => 'Indicates whether the description is displayed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'NeedUpgrade' => [ - 'description' => 'Indicates whether an upgrade is required.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'InstanceName' => [ - 'description' => 'The name of the exporter.'."\n", - 'type' => 'string', - 'example' => 'inet', - ], - 'ExporterType' => [ - 'description' => 'The type of the exporter.'."\n", - 'type' => 'string', - 'example' => 'kafka-exporter', - ], - 'IntegrationType' => [ - 'description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", - 'type' => 'string', - 'example' => 'Kafka, mysql, redis, snmp, emr, nubela, and tidb'."\n", - ], - 'InstanceId' => [ - 'description' => 'The ID of the exporter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '29374', - ], - 'Version' => [ - 'description' => 'The version number.'."\n", - 'type' => 'string', - 'example' => '1.0.0', - ], - 'Target' => [ - 'description' => 'The monitored IP address.'."\n", - 'type' => 'string', - 'example' => '121.40.62.240:3342', - ], - 'CanDelete' => [ - 'description' => 'Indicates whether the exporter can be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CanEditor' => [ - 'description' => 'Indicates whether the exporter can be edited.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Status' => [ - 'description' => 'The status of the exporter.'."\n", - 'type' => 'string', - 'example' => 'installed', - ], - 'ContainerName' => [ - 'description' => 'The name of the container.'."\n", - 'type' => 'string', - 'example' => 'container-1', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', - ], - 'PodName' => [ - 'description' => 'The pod name of the exporter.'."\n", - 'type' => 'string', - 'example' => 'kafka-exporter-1', + 'Alias' => ['description' => 'The alias of the add-on.'."\n", 'type' => 'string', 'example' => 'MySQL', 'title' => ''], + 'Categories' => [ + 'description' => 'The tags of the add-on.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tags.'."\n", 'type' => 'string', 'example' => 'cloud', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Describe' => [ - 'description' => 'The description of the exporter.'."\n", - 'type' => 'string', - 'example' => '"{}"', + 'Dashboards' => [ + 'description' => 'The dashboards.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Dashboard details.', + 'type' => 'object', + 'properties' => [ + 'Description' => ['description' => 'The description of the dashboard.'."\n", 'type' => 'string', 'example' => 'MySQL监控大盘信息，监控了连接信息、使用信息等指标', 'title' => ''], + 'Name' => ['description' => 'The name of the dashboard.'."\n", 'type' => 'string', 'example' => 'mysql-overview', 'title' => ''], + 'Url' => ['description' => 'The URL of the dashboard.'."\n", 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'ShowLog' => [ - 'description' => 'Indicates whether the exporter logs are displayed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'Description' => ['description' => 'The description of the add-on.'."\n", 'type' => 'string', 'example' => '通过 MySQL Exporter 监控数据库指标', 'title' => ''], + 'Environments' => [ + 'description' => 'The supported environments.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the environment.'."\n", + 'type' => 'object', + 'properties' => [ + 'Dependencies' => [ + 'description' => 'The dependencies of the environment.'."\n", + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => 'The feature on which the environment depends.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'boolean', 'description' => 'Indicates whether the feature is supported.'."\n", 'example' => 'true', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Services' => [ + 'description' => 'The services.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The service name.'."\n", 'type' => 'string', 'example' => 'ResourceCenter', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ClusterTypes' => [ + 'description' => 'The supported cluster types.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The cluster type.'."\n", 'type' => 'string', 'example' => 'ManagedKubernetes/Default', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the environment.'."\n", 'type' => 'string', 'example' => 'MySQL 服务部署在 Kubernetes 集群中。', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the feature is enabled.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Label' => ['description' => 'The tag of the environment.'."\n", 'type' => 'string', 'example' => '容器环境', 'title' => ''], + 'Name' => ['description' => 'The name of the environment.'."\n", 'type' => 'string', 'example' => 'CS', 'title' => ''], + 'Policies' => [ + 'description' => 'The control policies in the environment.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlertDefaultStatus' => ['description' => 'The default alert status.'."\n", 'type' => 'string', 'example' => 'default', 'title' => ''], + 'DefaultInstall' => ['description' => 'The default installation status.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TargetAddonName' => ['description' => 'The target name of the add-on.'."\n", 'type' => 'string', 'example' => 'cloud-rds-mysql', 'title' => ''], + 'Protocols' => [ + 'description' => 'The supported protocols.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Protocol details.', + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the protocol.'."\n", 'type' => 'string', 'example' => 'arms', 'title' => ''], + 'Label' => ['description' => 'The tag of the protocol.'."\n", 'type' => 'string', 'example' => 'ARMS', 'title' => ''], + 'Icon' => ['description' => 'The URL of the protocol icon.'."\n", 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + 'Description' => ['description' => 'The description of the protocol.'."\n", 'type' => 'string', 'example' => 'ARMS', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'EnableServiceAccount' => ['description' => 'Indicates whether a service account is enabled.'."\n", 'type' => 'boolean', 'example' => 'false.', 'title' => ''], + 'NeedRestartAfterIntegration' => ['description' => 'Indicates whether a restart is required after the installation.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'MetricCheckRule' => [ + 'description' => 'The metric check rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'PromQL' => [ + 'description' => 'The PromQL statements.'."\n", + 'type' => 'array', + 'items' => ['description' => 'PromQL statements are supported.'."\n", 'type' => 'string', 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], - 'Param' => [ - 'title' => 'exporter配置参数json串', - 'description' => 'The configurations of the exporter. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{'."\n" - .' "port": "5554",'."\n" - .' "name": "kafka-test12",'."\n" - .' "kafka_instance": "kafka-test",'."\n" - .' "__label_value": "kafka-test",'."\n" - .' "scrape_interval": 33,'."\n" - .' "metrics_path": "/metrics",'."\n" - .' "__label_key": "kafka-test"'."\n" - .'}', + 'Icon' => ['description' => 'The URL of the icon.'."\n", 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], + 'Keywords' => [ + 'description' => 'The collection of keywords.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The keyword.'."\n", 'type' => 'string', 'example' => 'Java', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Language' => ['description' => 'The language.'."\n", 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'Name' => ['description' => 'The name of the add-on.'."\n", 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'Once' => ['description' => 'Indicates whether the add-on can be installed only once.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Scene' => ['description' => 'The scenario.'."\n", 'type' => 'string', 'example' => 'database', 'title' => ''], + 'Version' => ['description' => 'The version of the agent.'."\n", 'type' => 'string', 'example' => '0.0.1', 'title' => ''], + 'Weight' => ['description' => 'The weight.'."\n", 'type' => 'string', 'example' => '857', 'title' => ''], + 'LatestReleaseCreateTime' => ['description' => 'The time when the instance was last created.'."\n", 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F1D8840-5330-5804-A8DB-C3C5C5******\\",\\n \\"Data\\": [\\n {\\n \\"ClusterId\\": \\"c77f6f2397ea74672872acf5e31******\\",\\n \\"ShowDescribe\\": true,\\n \\"NeedUpgrade\\": true,\\n \\"InstanceName\\": \\"inet\\",\\n \\"ExporterType\\": \\"kafka-exporter\\",\\n \\"IntegrationType\\": \\"kafka\\",\\n \\"InstanceId\\": 0,\\n \\"Version\\": \\"1.0.0\\",\\n \\"Target\\": \\"121.40.XX.XX:3342\\",\\n \\"CanDelete\\": true,\\n \\"CanEditor\\": true,\\n \\"Status\\": \\"installed\\",\\n \\"ContainerName\\": \\"container-1\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodName\\": \\"kafka-exporter-1\\",\\n \\"Describe\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"ShowLog\\": true,\\n \\"Param\\": \\"{\\\\n \\\\\\"port\\\\\\": \\\\\\"5554\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"kafka-test12\\\\\\",\\\\n \\\\\\"kafka_instance\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"__label_value\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"scrape_interval\\\\\\": 33,\\\\n \\\\\\"metrics_path\\\\\\": \\\\\\"/metrics\\\\\\",\\\\n \\\\\\"__label_key\\\\\\": \\\\\\"kafka-test\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'ListPrometheusIntegration', - ], - 'GetPrometheusInstance' => [ - 'summary' => 'Queries the information about a Prometheus instance.', - 'methods' => [ - 'get', - 'post', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Alias\\": \\"MySQL\\",\\n \\"Categories\\": [\\n \\"cloud\\"\\n ],\\n \\"Dashboards\\": [\\n {\\n \\"Description\\": \\"MySQL监控大盘信息，监控了连接信息、使用信息等指标\\",\\n \\"Name\\": \\"mysql-overview\\",\\n \\"Url\\": \\"http://xxxx\\"\\n }\\n ],\\n \\"Description\\": \\"通过 MySQL Exporter 监控数据库指标\\",\\n \\"Environments\\": [\\n {\\n \\"Dependencies\\": {\\n \\"Features\\": {\\n \\"key\\": true\\n },\\n \\"Services\\": [\\n \\"ResourceCenter\\"\\n ],\\n \\"ClusterTypes\\": [\\n \\"ManagedKubernetes/Default\\"\\n ]\\n },\\n \\"Description\\": \\"MySQL 服务部署在 Kubernetes 集群中。\\",\\n \\"Enable\\": true,\\n \\"Label\\": \\"容器环境\\",\\n \\"Name\\": \\"CS\\",\\n \\"Policies\\": {\\n \\"AlertDefaultStatus\\": \\"default\\",\\n \\"DefaultInstall\\": false,\\n \\"TargetAddonName\\": \\"cloud-rds-mysql\\",\\n \\"Protocols\\": [\\n {\\n \\"Name\\": \\"arms\\",\\n \\"Label\\": \\"ARMS\\",\\n \\"Icon\\": \\"http://xxxxxxx\\",\\n \\"Description\\": \\"ARMS\\"\\n }\\n ],\\n \\"EnableServiceAccount\\": true,\\n \\"NeedRestartAfterIntegration\\": false,\\n \\"MetricCheckRule\\": {\\n \\"PromQL\\": [\\n \\"scraper_up{scraper=\\\\\\\\\\\\\\"ecs\\\\\\\\\\\\\\"}==1\\"\\n ]\\n }\\n }\\n }\\n ],\\n \\"Icon\\": \\"http://xxxx\\",\\n \\"Keywords\\": [\\n \\"Java\\"\\n ],\\n \\"Language\\": \\"zh\\",\\n \\"Name\\": \\"mysql\\",\\n \\"Once\\": false,\\n \\"Scene\\": \\"database\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"Weight\\": \\"857\\",\\n \\"LatestReleaseCreateTime\\": \\"2023-09-22T16:56:29+08:00\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListAddons', + 'changeSet' => [ + ['createdAt' => '2024-06-07T08:50:37.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddons'], + ], ], + 'ramActions' => [], + ], + 'ListAlertEvents' => [ + 'summary' => 'Queries historical alert events.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -23768,36 +18880,51 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '163198', - 'abilityTreeNodes' => [ - 'FEATUREarmsFRX7PL', - ], - 'tenantRelevance' => 'tenant', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AlertName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'required' => false, 'example' => '测试触发的告警'], ], [ - 'name' => 'ClusterId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'c77f6f2397ea74672872acf5e31374a27', - ], + 'schema' => ['title' => '', 'description' => 'The start time of the alert events that you want to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-12-19 00:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time of the alert events that you want to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-12-22 23:59:59'], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + ], + [ + 'name' => 'MatchingConditions', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The list of matching conditions.'."\n", 'type' => 'string', 'required' => false, 'example' => '[ { "value": "ARMS_NOTIFICATION", "key": "clustername", "operator": "eq" } ] },{ "matchingConditions": [ { "value": "test", "key": "alertname", "operator": "eq" } ]'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the alert events. Valid values:'."\n" + ."\n" + .'* Active'."\n" + .'* Silenced'."\n" + .'* Resolved'."\n", 'type' => 'string', 'required' => false, 'example' => 'Active', 'title' => ''], + ], + [ + 'name' => 'ShowNotificationPolicies', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to show the associated notification policy.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], ], 'responses' => [ @@ -23807,306 +18934,118 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '52C422FD-6B43-524D-B8A1-A4693294318C', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Data' => [ - 'description' => 'The response parameters.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-beijing', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '167275301789****', - ], - 'ClusterName' => [ - 'description' => 'The name of the monitoring object.'."\n", - 'type' => 'string', - 'example' => 'prom1', - ], - 'ClusterType' => [ - 'title' => ' remote-write（Prometheus for Remote Write）'."\n" - .' ecs（Prometheus for ECS）'."\n" - .' cloud-monitor（Prometheus for 云服务 国内）'."\n" - .' cloud-product（Prometheus for 云服务 国外）'."\n" - .' global-view（Prometheus for GlobalView）'."\n" - .' aliyun-cs（Prometheus for 容器服务）', - 'description' => '* remote-write: general-purpose Prometheus instance'."\n" - .'* ecs: Prometheus instances for ECS'."\n" - .'* cloud-monitor: Prometheus instance for Alibaba Cloud services in the Chinese mainland'."\n" - .'* cloud-product: Prometheus instance for Alibaba Cloud services outside the Chinese mainland'."\n" - .'* global-view: global aggregation instance'."\n" - .'* aliyun-cs: Prometheus instance for Container Service'."\n", - 'type' => 'string', - 'example' => 'remote-write', - ], - 'VpcId' => [ - 'description' => 'The VPC ID. This parameter is returned only for Prometheus instances for ECS.'."\n", - 'type' => 'string', - 'example' => 'vpc-8vb02uk57qbcktqcvqqqj', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID. This parameter is returned only for Prometheus instances for ECS.'."\n", - 'type' => 'string', - 'example' => 'vsw-f8z73vcja1tqnw90aav5a', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group. This parameter is returned only for Prometheus instances for ECS.'."\n", - 'type' => 'string', - 'example' => 'sg-8vbdgmf4nraiqa9bx0jo', - ], - 'SubClustersJson' => [ - 'title' => 'globalView实例的子实例json串', - 'description' => 'The child instances of the global aggregation instance. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '\\[{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73\\*\\*\\*","sourceName":"arms-luyao-test","dataSource":"","userId":"167275301789\\*\\*\\*"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5\\*\\*\\*\\*","sourceName":"agent-321-test","dataSource":"","userId":"1672753017899\\*\\*\\*"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"167275301789\\*\\*\\*"}]'."\n", - ], - 'RemoteReadIntraUrl' => [ - 'description' => 'The internal URL for remote read.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', - ], - 'RemoteReadInterUrl' => [ - 'description' => 'The public URL for remote read.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', - ], - 'RemoteWriteIntraUrl' => [ - 'description' => 'The internal URL for remote write.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write', - ], - 'RemoteWriteInterUrl' => [ - 'description' => 'The public URL for remote write.'."\n", - 'type' => 'string', - 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write', - ], - 'PushGatewayIntraUrl' => [ - 'description' => 'The internal URL for Pushgateway.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2', - ], - 'PushGatewayInterUrl' => [ - 'description' => 'The public URL for Pushgateway.'."\n", - 'type' => 'string', - 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2', - ], - 'OpenTelemetryInterUrl' => [ - 'type' => 'string', - ], - 'HttpApiIntraUrl' => [ - 'description' => 'The internal URL for the HTTP API.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx', - ], - 'HttpApiInterUrl' => [ - 'description' => 'The public URL for the HTTP API.'."\n", - 'type' => 'string', - 'example' => 'https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx', - ], - 'AuthToken' => [ - 'description' => 'The authorization token.'."\n", - 'type' => 'string', - 'example' => 'GciOiJIUzI1NiJ9***', - ], - 'AccessType' => [ - 'title' => '权限类型：'."\n" - .'readWrite、readOnly、httpReadOnly', - 'description' => 'The permission type. Valid values: readWrite, readOnly, and httpReadOnly'."\n", - 'type' => 'string', - 'example' => 'readWrite', - ], - 'PaymentType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* PREPAY: subscription'."\n" - .'* POSTPAY: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'PREPAY', - ], - 'StorageDuration' => [ - 'title' => '存储时长（天）。', - 'description' => 'The data storage duration. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '90', - ], - 'ArchiveDuration' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', - 'description' => 'The number of days for which data is automatically archived after the storage duration expires. Valid values: 60, 90, 180, and 365. 0 indicates that the data is not archived.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '60', - ], - 'GrafanaInstanceId' => [ - 'description' => 'The ID of the Grafana workspace.'."\n", - 'type' => 'string', - 'example' => 'grafana-rnggfvhlcdl6m71***', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group to which the instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2vezare****', - ], - 'ResourceType' => [ - 'title' => '固定值：PROMETHEUS', - 'description' => 'The type of the resource. Set the value to PROMETHEUS.'."\n", - 'type' => 'string', - 'example' => 'PROMETHEUS', - ], - 'EnableAuthToken' => [ - 'title' => '是否开启访问Token鉴权', - 'description' => 'Indicates whether access token authentication is enabled.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'SupportAuthTypes' => [ - 'description' => 'The supported authentication types.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The supported authentication type.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* BasicAuth: HTTP basic authentication'."\n" - .'* AuthFree: password-free authentication'."\n" - .'* AuthToken: token authentication'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'BasicAuth' => '', - 'AuthFree' => '', - 'AuthToken' => '', - ], - 'example' => 'AuthFree', - ], - ], - 'EnableAuthFreeRead' => [ - 'title' => '是否开启读免密。', - 'description' => 'Indicates whether password-free read is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AuthFreeReadPolicy' => [ - 'title' => '读免密地址白名单策略。', - 'description' => 'The whitelist of IP addresses for which password-free read is enabled.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'EnableAuthFreeWrite' => [ - 'title' => '是否开启写免密。', - 'description' => 'Indicates whether password-free write is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'AuthFreeWritePolicy' => [ - 'title' => '写免密地址白名单策略。', - 'description' => 'The whitelist of IP addresses for which password-free write is enabled.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Product' => [ - 'title' => 'prom实例归属的产品（arms或cms）', - 'description' => 'The product to which the Prometheus instance belongs. Valid values: arms and cms.'."\n", - 'type' => 'string', - 'example' => 'arms', - ], - 'DbInstanceStatus' => [ - 'title' => '后端数据存储状态', - 'description' => 'The data storage status at the backend.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'Version' => [ - 'title' => '版本', - 'description' => 'Version'."\n", - 'type' => 'string', - 'example' => 'V1', - ], - 'PaymentTypeUpdateTime' => [ - 'title' => '实例计费方式修改时间', - 'description' => 'The time when the billing method was modified.'."\n", - 'type' => 'string', - 'example' => '2025-02-26T06:05:01Z', - ], - 'ExtraInfo' => [ - 'title' => '扩展信息（仅控制台请求才返回）', - 'description' => 'The extra information. This parameter is returned only for console requests.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The extended information.'."\n", - 'example' => 'key1', - ], - ], - 'Tags' => [ - 'description' => 'The tags of the instance.'."\n", + 'Total' => ['title' => '', 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Page' => ['title' => '', 'description' => 'The number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'Events' => [ + 'title' => '', + 'description' => 'The queried historical alert events.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => 'The alert events.'."\n", 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'tag1', + 'AlertName' => ['title' => '', 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'example' => '测试触发的告警'], + 'Severity' => ['title' => '', 'description' => 'The severity level of the alert. Valid values:'."\n" + ."\n" + .'* critical: P1'."\n" + .'* error: P2'."\n" + .'* warning: P3'."\n" + .'* page: P4'."\n" + .'* default: P6'."\n", 'type' => 'string', 'example' => 'critical'], + 'Status' => ['title' => '', 'description' => 'The status of the alert event. Valid values:'."\n" + ."\n" + .'* Active'."\n" + .'* Silenced'."\n" + .'* Resolved'."\n", 'type' => 'string', 'example' => 'Active'], + 'StartTime' => ['title' => '', 'description' => 'The start time.'."\n", 'type' => 'string', 'example' => '2021-12-20 17:42:16'], + 'EndTime' => ['title' => '', 'description' => 'The end time.'."\n", 'type' => 'string', 'example' => '2021-12-20 17:42:16'], + 'ReceiveTime' => ['title' => '', 'description' => 'The time when the alert event was received.'."\n", 'type' => 'string', 'example' => '2021-12-20 17:42:16'], + 'IntegrationName' => ['title' => '', 'description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'example' => '自定义集成'], + 'IntegrationType' => ['title' => '', 'description' => 'The type of the alert integration.'."\n", 'type' => 'string', 'example' => 'CUSTOM'], + 'GeneratorURL' => ['title' => '', 'description' => 'The URL of the alert event.'."\n", 'type' => 'string', 'example' => 'https://xxx.xx/'], + 'Description' => ['title' => '', 'description' => 'The description of the alert event.'."\n", 'type' => 'string', 'example' => '测试'], + 'Annotations' => ['title' => '', 'description' => 'The annotations.'."\n", 'type' => 'string', 'example' => '[{\\"Name\\":\\"annotation-a\\",\\"Value\\":\\"annotation a value\\"}]'], + 'Labels' => ['title' => '', 'description' => 'The tags.'."\n", 'type' => 'string', 'example' => '[{\\"name\\":\\"severity\\",\\"value\\":\\"error\\"}]'], + 'Alarms' => [ + 'title' => '', + 'description' => 'The associated alerts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the alert.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlarmId' => ['title' => '', 'description' => 'The ID of the alert.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '77444'], + 'AlarmName' => ['title' => '', 'description' => 'The name of the alert.'."\n", 'type' => 'string', 'example' => '测试触发的告警'], + 'State' => ['title' => '', 'description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'* 0: The alert is pending.'."\n" + .'* 1: The alert is being handled.'."\n" + .'* 2: The alert is cleared.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the alert was created.'."\n", 'type' => 'string', 'example' => '2021-12-20 07:10:18'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'tagValue1', + 'HandlerName' => ['description' => 'The user who handled the alert.'."\n", 'type' => 'string', 'example' => '张三', 'title' => ''], + 'NotificationPolicies' => [ + 'description' => 'The associated notification policies.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The notification policies.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '646093', 'title' => ''], + 'Name' => ['description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => 'P1告警通知策略', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'TriggerCount' => ['description' => 'The number of times the event is triggered.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'OpenTelemetryIntraUrl' => [ - 'type' => 'string', + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"52C422FD-6B43-524D-B8A1-A4693294318C\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"ClusterId\\": \\"c589a1b8db05c4561aefbb898ca8fb1cf\\",\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"UserId\\": \\"167275301789****\\",\\n \\"ClusterName\\": \\"prom1\\",\\n \\"ClusterType\\": \\"remote-write\\",\\n \\"VpcId\\": \\"vpc-8vb02uk57qbcktqcvqqqj\\",\\n \\"VSwitchId\\": \\"vsw-f8z73vcja1tqnw90aav5a\\",\\n \\"SecurityGroupId\\": \\"sg-8vbdgmf4nraiqa9bx0jo\\",\\n \\"SubClustersJson\\": \\"[{\\\\\\"headers\\\\\\":{},\\\\\\"regionId\\\\\\":\\\\\\"cn-hangzhou\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"extras\\\\\\":{},\\\\\\"clusterId\\\\\\":\\\\\\"c39a1048921e04fceb039db2fbb73***\\\\\\",\\\\\\"sourceName\\\\\\":\\\\\\"arms-luyao-test\\\\\\",\\\\\\"dataSource\\\\\\":\\\\\\"\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"167275301789***\\\\\\"},{\\\\\\"headers\\\\\\":{},\\\\\\"regionId\\\\\\":\\\\\\"cn-beijing\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"extras\\\\\\":{},\\\\\\"clusterId\\\\\\":\\\\\\"c6b6485496d5b400abde22cb47b5****\\\\\\",\\\\\\"sourceName\\\\\\":\\\\\\"agent-321-测试\\\\\\",\\\\\\"dataSource\\\\\\":\\\\\\"\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"1672753017899***\\\\\\"},{\\\\\\"headers\\\\\\":{},\\\\\\"regionId\\\\\\":\\\\\\"cn-zhangjiakou\\\\\\",\\\\\\"sourceType\\\\\\":\\\\\\"AlibabaPrometheus\\\\\\",\\\\\\"extras\\\\\\":{},\\\\\\"clusterId\\\\\\":\\\\\\"c261a4f3200c446659133f1ade789b15e\\\\\\",\\\\\\"sourceName\\\\\\":\\\\\\"zaifeng-cardinality-01\\\\\\",\\\\\\"dataSource\\\\\\":\\\\\\"\\\\\\",\\\\\\"userId\\\\\\":\\\\\\"167275301789***\\\\\\"}]\\",\\n \\"RemoteReadIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteReadInterUrl\\": \\"http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteWriteIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"RemoteWriteInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"PushGatewayIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"PushGatewayInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"OpenTelemetryInterUrl\\": \\"\\",\\n \\"HttpApiIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx\\",\\n \\"HttpApiInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx\\",\\n \\"AuthToken\\": \\"GciOiJIUzI1NiJ9***\\",\\n \\"AccessType\\": \\"readWrite\\",\\n \\"PaymentType\\": \\"PREPAY\\",\\n \\"StorageDuration\\": 90,\\n \\"ArchiveDuration\\": 60,\\n \\"GrafanaInstanceId\\": \\"grafana-rnggfvhlcdl6m71***\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\",\\n \\"ResourceType\\": \\"PROMETHEUS\\",\\n \\"EnableAuthToken\\": \\"true\\",\\n \\"SupportAuthTypes\\": [\\n \\"AuthFree\\"\\n ],\\n \\"EnableAuthFreeRead\\": true,\\n \\"AuthFreeReadPolicy\\": \\"0.0.0.0/0\\",\\n \\"EnableAuthFreeWrite\\": true,\\n \\"AuthFreeWritePolicy\\": \\"0.0.0.0/0\\",\\n \\"Product\\": \\"arms\\",\\n \\"DbInstanceStatus\\": \\"RUNNING\\",\\n \\"Version\\": \\"V1\\",\\n \\"PaymentTypeUpdateTime\\": \\"2025-02-26T06:05:01Z\\",\\n \\"ExtraInfo\\": {\\n \\"key\\": \\"extraKey\\"\\n },\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"tag1\\",\\n \\"TagValue\\": \\"tagValue1\\"\\n }\\n ],\\n \\"OpenTelemetryIntraUrl\\": \\"\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetPrometheusInstance', - ], - 'ListPrometheusInstanceByTagAndResourceGroupId' => [ - 'summary' => 'Queries Prometheus instances by tag and resource group.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 24,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"Events\\": [\\n {\\n \\"AlertName\\": \\"测试触发的告警\\",\\n \\"Severity\\": \\"critical\\",\\n \\"Status\\": \\"Active\\",\\n \\"StartTime\\": \\"2021-12-20 17:42:16\\",\\n \\"EndTime\\": \\"2021-12-20 17:42:16\\",\\n \\"ReceiveTime\\": \\"2021-12-20 17:42:16\\",\\n \\"IntegrationName\\": \\"自定义集成\\",\\n \\"IntegrationType\\": \\"CUSTOM\\",\\n \\"GeneratorURL\\": \\"https://xxx.xx/\\",\\n \\"Description\\": \\"测试\\",\\n \\"Annotations\\": \\"[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"annotation-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"annotation a value\\\\\\\\\\\\\\"}]\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"severity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"error\\\\\\\\\\\\\\"}]\\",\\n \\"Alarms\\": [\\n {\\n \\"AlarmId\\": 77444,\\n \\"AlarmName\\": \\"测试触发的告警\\",\\n \\"State\\": 0,\\n \\"CreateTime\\": \\"2021-12-20 07:10:18\\"\\n }\\n ],\\n \\"HandlerName\\": \\"张三\\",\\n \\"NotificationPolicies\\": [\\n {\\n \\"Id\\": 646093,\\n \\"Name\\": \\"P1告警通知策略\\"\\n }\\n ],\\n \\"TriggerCount\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListAlertEvents', + 'changeSet' => [ + ['createdAt' => '2024-05-11T08:54:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-11T02:37:06.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-20T08:38:47.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-25T12:11:01.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertEvents'], + ], ], + 'ramActions' => [], + ], + 'ListAlerts' => [ + 'summary' => 'Queries the alert sending history.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -24114,59 +19053,102 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'AlertName', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'required' => false, 'example' => '告警测试'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'State', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['title' => '', 'description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'* 0: The alert is pending.'."\n" + .'* 1: The alert is being handled.'."\n" + .'* 2: The alert is handled.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2'], ], [ - 'name' => 'Tag', + 'name' => 'Severity', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag of the resource.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fpx-tag', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'fvt-tag-value', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'schema' => ['title' => '', 'description' => 'The severity level of the alert. Valid values: P6, P5, P4, P3, P2, and P1. The preceding values are listed in ascending order of severity.'."\n", 'type' => 'string', 'required' => false, 'example' => 'P6'], + ], + [ + 'name' => 'DispatchRuleId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '12345'], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The integration type.'."\n" + ."\n" + .'* ARMS'."\n" + .'* CLOUD_MONITOR'."\n" + .'* MSE'."\n" + .'* ARMS_CLOUD_DIALTEST'."\n" + .'* PROMETHEUS'."\n" + .'* LOG_SERVICE'."\n" + .'* CUSTOM'."\n" + .'* ARMS_PROMETHEUS'."\n" + .'* ARMS_APP_MON'."\n" + .'* ARMS_FRONT_MON'."\n" + .'* ARMS_CUSTOM'."\n" + .'* XTRACE'."\n" + .'* GRAFANA'."\n" + .'* ZABBIX'."\n" + .'* SKYWALKING'."\n" + .'* EVENT_BRIDGE'."\n" + .'* NAGIOS'."\n" + .'* OPENFALCON'."\n" + .'* ARMS_INSIGHTS'."\n", 'type' => 'string', 'required' => false, 'example' => 'ARMS_APP_MON'], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The start time of the alert sending history that you want to query. Specify the time in the `YYYY-MM-DD HH:mm:ss` format.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-12-10 00:00:00'], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The end time of the alert sending history that you want to query. Specify the time in the `YYYY-MM-DD HH:mm:ss` format.'."\n", 'type' => 'string', 'required' => false, 'example' => '2021-12-22 23:59:59'], + ], + [ + 'name' => 'ShowEvents', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to query the events that correspond to alerts. Valid values:'."\n" + ."\n" + .'* `false` (default value): The events are not queried.'."\n" + .'* `true`: The events are queried.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'ShowActivities', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to query the activities that correspond to alerts. Valid values:'."\n" + ."\n" + .'* `false` (default value): The activities are not queried.'."\n" + .'* `true`: The activities in the last three days are queried.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of alerts to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => ['description' => 'The notification object configured in the notification policy, responsible for handling alerts.'."\n", 'type' => 'string', 'required' => false, 'example' => '张三', 'title' => ''], ], ], 'responses' => [ @@ -24176,494 +19158,411 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '4789C3E9-A85A-524B-B97B-9D2B14BA06BC', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'PrometheusInstances' => [ - 'description' => 'The queried Prometheus instances.'."\n", + 'Total' => ['title' => '', 'description' => 'The total number of queried alerts.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of alerts returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'ListAlerts' => [ + 'title' => '', + 'description' => 'The queried alert notification history records.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The object struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'ClusterId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'c9d5dda1aeca64220853ace304baeb03d', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-shanghai', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '1672753017899***', - ], - 'ClusterName' => [ - 'description' => 'The name of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'prom1', - ], - 'ClusterType' => [ - 'title' => ' remote-write（Prometheus for Remote Write）'."\n" - .' ecs（Prometheus for ECS）'."\n" - .' cloud-monitor（Prometheus for 云服务 国内）'."\n" - .' cloud-product（Prometheus for 云服务 国外）'."\n" - .' global-view（Prometheus for GlobalView）'."\n" - .' aliyun-cs（Prometheus for 容器服务）', - 'description' => 'The instance type. Valid values:'."\n" - ."\n" - .'* remote-write: Prometheus instance for Remote Write'."\n" - .'* ecs: Prometheus instances for ECS'."\n" - .'* cloud-monitor: Prometheus instance for Alibaba Cloud services in the Chinese mainland'."\n" - .'* cloud-product: Prometheus instance for Alibaba Cloud services outside the Chinese mainland'."\n" - .'* global-view: global aggregation instance'."\n" - .'* aliyun-cs: Prometheus instance for Container Service'."\n", - 'type' => 'string', - 'example' => 'ecs', - ], - 'VpcId' => [ - 'description' => 'The ID of the virtual private cloud (VPC).'."\n", - 'type' => 'string', - 'example' => 'vpc-8vbtp1fsm8mir18l8rl0u', - ], - 'VSwitchId' => [ - 'description' => 'The ID of the vSwitch.'."\n", - 'type' => 'string', - 'example' => 'vsw-f8z73vcja1tqnw90aav5a', - ], - 'SecurityGroupId' => [ - 'description' => 'The ID of the security group.'."\n", - 'type' => 'string', - 'example' => 'sg-f8zd1toc10wmbi1v5rom', - ], - 'SubClustersJson' => [ - 'title' => 'globalView实例的子实例json串', - 'description' => 'The child instances of the global aggregation instance. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '\\[ { "headers": {}, "regionId": "cn-hangzhou", "sourceType": "AlibabaPrometheus", "extras": {}, "clusterId": "c39a1048921e04fceb039db2fb\\*\\*\\*\\*", "sourceName": "arms-luyao-test", "dataSource": "", "userId": "167275301789\\*\\*\\*\\*" }, { "headers": {}, "regionId": "cn-beijing", "sourceType": "AlibabaPrometheus", "extras": {}, "clusterId": "c6b6485496d5b400abde22cb47b5\\*\\*\\*\\*", "sourceName": "agent-321-test", "dataSource": "", "userId": "167275301789\\*\\*\\*\\*" }, { "headers": {}, "regionId": "cn-zhangjiakou", "sourceType": "AlibabaPrometheus", "extras": {}, "clusterId": "c261a4f3200c446659133f1ade78\\*\\*\\*\\*", "sourceName": "zaifeng-cardinality-01", "dataSource": "", "userId": "167275301789\\*\\*\\*\\*" } ]'."\n", - ], - 'RemoteReadIntraUrl' => [ - 'description' => 'The internal URL for remote read.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', - ], - 'RemoteReadInterUrl' => [ - 'description' => 'The public URL for remote read.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', - ], - 'RemoteWriteIntraUrl' => [ - 'description' => 'The internal URL for remote write.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write'."\n", - ], - 'RemoteWriteInterUrl' => [ - 'description' => 'The public URL for remote write.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write'."\n", - ], - 'PushGatewayIntraUrl' => [ - 'description' => 'The internal URL for Pushgateway.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2'."\n", - ], - 'PushGatewayInterUrl' => [ - 'description' => 'The public URL for Pushgateway.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2'."\n", - ], - 'HttpApiIntraUrl' => [ - 'description' => 'The internal URL for the HTTP API.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/cn-beijing', - ], - 'HttpApiInterUrl' => [ - 'description' => 'The public URL for the HTTP API.'."\n", - 'type' => 'string', - 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/cn-beijing', - ], - 'AuthToken' => [ - 'description' => 'The authorization token.'."\n", - 'type' => 'string', - 'example' => 'ad32dxxxx'."\n", - ], - 'PaymentType' => [ - 'description' => 'The billing method. Valid values:'."\n" - ."\n" - .'* PREPAY: subscription'."\n" - .'* POSTPAY: pay-as-you-go'."\n", - 'type' => 'string', - 'example' => 'POSTPAY', - ], - 'GrafanaInstanceId' => [ - 'description' => 'The ID of the Grafana workspace.'."\n", - 'type' => 'string', - 'example' => 'grafana-rnggfvhlcdl6m71l**', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmz7nocpeidcy', - ], - 'ResourceType' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'PROMETHEUS', + 'AlertName' => ['title' => '', 'description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'example' => '告警测试'], + 'Severity' => ['title' => '', 'description' => 'The severity level of the alert. Valid values: P6, P5, P4, P3, P2, and P1. The preceding values are listed in ascending order of severity.'."\n", 'type' => 'string', 'example' => 'P6'], + 'State' => ['title' => '', 'description' => 'The status of the alert. Valid values:'."\n" + ."\n" + .'* 0: The alert is pending.'."\n" + .'* 1: The alert is being handled.'."\n" + .'* 2: The alert is handled.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '0'], + 'DispatchRuleId' => ['title' => '', 'description' => 'The ID of the notification policy.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '12345'], + 'DispatchRuleName' => ['title' => '', 'description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => '钉群通知'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the alert was created.'."\n", 'type' => 'string', 'example' => '2022-01-18 00:21:35'], + 'Activities' => [ + 'title' => '', + 'description' => 'The list of activities.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The details of each activity.'."\n", + 'type' => 'object', + 'properties' => [ + 'Time' => ['title' => '', 'description' => 'The operation time of the activity.'."\n", 'type' => 'string', 'example' => '2021-12-20 19:08:57'], + 'Type' => ['title' => '', 'description' => 'The type of the activity. Valid values:'."\n" + ."\n" + .'* 1: The alert is claimed.'."\n" + .'* 2: The alert is disclaimed.'."\n" + .'* 3: A comment is added for the alert.'."\n" + .'* 4: The alert is disabled.'."\n" + .'* 5: An alert notification is sent.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'HandlerName' => ['title' => '', 'description' => 'The name of the handler.'."\n", 'type' => 'string', 'example' => '运维A'], + 'Description' => ['title' => '', 'description' => 'The description of the activity.'."\n", 'type' => 'string', 'example' => '[告警认领]认领了该告警'], + 'Content' => ['title' => '', 'description' => 'The content of the alert notification.'."\n", 'type' => 'string', 'example' => '【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %'], + ], + 'title' => '', + 'example' => '', + ], + 'example' => '', ], - 'Tags' => [ - 'description' => 'The list of tags.'."\n", + 'AlertEvents' => [ + 'title' => '', + 'description' => 'The list of events.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => 'The details of each event.'."\n", 'type' => 'object', 'properties' => [ - 'TagKey' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'ac-cus-tag-3', - ], - 'TagValue' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'asg-2vc8qq7x89o11rus9uvu', - ], + 'AlertName' => ['title' => '', 'description' => 'The name of the event.'."\n", 'type' => 'string', 'example' => '测试触发的告警'], + 'Severity' => ['title' => '', 'description' => 'The severity level of the event. Valid values:'."\n" + ."\n" + .'* critical'."\n" + .'* error'."\n" + .'* warning'."\n" + .'* info'."\n", 'type' => 'string', 'example' => 'warning'], + 'State' => ['title' => '', 'description' => 'The status of the event. Valid values:'."\n" + ."\n" + .'* Active: The event is not cleared.'."\n" + .'* Silenced: The event is silenced.'."\n" + .'* Resolved: The event is cleared.'."\n", 'type' => 'string', 'example' => 'Active'], + 'StartTime' => ['title' => '', 'description' => 'The time when the event started.'."\n", 'type' => 'string', 'example' => '2022-01-18 00:14:00'], + 'EndTime' => ['title' => '', 'description' => 'The time when the event ended.'."\n", 'type' => 'string', 'example' => '2022-01-19 17:10:31'], + 'ReceiveTime' => ['title' => '', 'description' => 'The time when the event was created.'."\n", 'type' => 'string', 'example' => '2022-01-19 17:05:42'], + 'IntegrationName' => ['title' => '', 'description' => 'The name of the integration that corresponds to the alert event.'."\n", 'type' => 'string', 'example' => 'ARMS'], + 'IntegrationType' => ['title' => '', 'description' => 'The type of the integration that corresponds to the alert event. Valid values:'."\n" + ."\n" + .'* ARMS'."\n" + .'* CLOUD_MONITOR'."\n" + .'* MSE'."\n" + .'* ARMS_CLOUD_DIALTEST'."\n" + .'* PROMETHEUS'."\n" + .'* LOG_SERVICE'."\n" + .'* CUSTOM'."\n" + .'* ARMS_PROMETHEUS'."\n" + .'* ARMS_APP_MON'."\n" + .'* ARMS_FRONT_MON'."\n" + .'* ARMS_CUSTOM'."\n" + .'* XTRACE'."\n" + .'* GRAFANA'."\n" + .'* ZABBIX'."\n" + .'* SKYWALKING'."\n" + .'* EVENT_BRIDGE'."\n" + .'* NAGIOS'."\n" + .'* OPENFALCON'."\n" + .'* ARMS_INSIGHTS'."\n", 'type' => 'string', 'example' => 'ARMS_APP_MON'], + 'GeneratorURL' => ['title' => '', 'description' => 'The URL of the event.'."\n", 'type' => 'string', 'example' => 'http://arms.console.aliyun.com'], + 'Description' => ['title' => '', 'description' => 'The description of the event.'."\n", 'type' => 'string', 'example' => '主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %'], + 'Annotations' => ['description' => 'The annotations.'."\n", 'type' => 'string', 'example' => '{ "_aliyun_arms_alert_value":"4.0" "_aliyun_arms_alert_traceId":"ac10c43116421327442277073d5461-105075299"}', 'title' => ''], + 'Labels' => ['title' => '', 'description' => 'The tags.'."\n", 'type' => 'string', 'example' => '{ "severity":"warning" "_aliyun_arms_alert_level":"ERROR" "_aliyun_arms_entropy":"0.30170457417889235"}'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], + 'AlertId' => ['title' => '', 'description' => 'The alert ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2279'], + 'Solution' => ['title' => '', 'description' => 'The Alert solution.', 'type' => 'string', 'example' => '重启解决'], + 'Owner' => ['description' => 'The notification object configured in the notification policy, responsible for handling alerts.', 'type' => 'string', 'example' => '通知策略中配置的联系人通知对象', 'title' => ''], + 'Handler' => ['description' => 'Alarm handler.', 'type' => 'string', 'example' => '认领、关闭告警的处理人', 'title' => ''], + 'AcknowledgeTime' => ['description' => 'Time to claim the alarm.', 'type' => 'integer', 'format' => 'int64', 'example' => '告警从发生到认领之间的时长', 'default' => '-1', 'title' => ''], + 'RecoverTime' => ['description' => 'Alarm recovery time.', 'type' => 'integer', 'format' => 'int64', 'example' => '告警从发生到恢复之间的时长', 'default' => '-1', 'title' => ''], + 'NotifyRobots' => ['description' => 'The contact card of an instant messaging app.'."\n", 'type' => 'string', 'example' => '钉钉的名片。', 'title' => ''], + 'Describe' => ['description' => 'The description of a event execution status.'."\n", 'type' => 'string', 'example' => '[告警通知]通过[webhook]通知了xxx(成功）', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], - 'Code' => [ - 'description' => 'The response code. 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' => 'message', - ], + 'Message' => ['description' => 'The returned error message.'."\n", 'type' => 'string', 'example' => 'alert.manager.error.code.signature.invalid', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4789C3E9-A85A-524B-B97B-9D2B14BA06BC\\",\\n \\"Data\\": {\\n \\"PrometheusInstances\\": [\\n {\\n \\"ClusterId\\": \\"c9d5dda1aeca64220853ace304baeb03d\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"UserId\\": \\"1672753017899***\\",\\n \\"ClusterName\\": \\"prom1\\",\\n \\"ClusterType\\": \\"ecs\\",\\n \\"VpcId\\": \\"vpc-8vbtp1fsm8mir18l8rl0u\\",\\n \\"VSwitchId\\": \\"vsw-f8z73vcja1tqnw90aav5a\\",\\n \\"SecurityGroupId\\": \\"sg-f8zd1toc10wmbi1v5rom\\",\\n \\"SubClustersJson\\": \\"[\\\\n {\\\\n \\\\\\"headers\\\\\\": {},\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"AlibabaPrometheus\\\\\\",\\\\n \\\\\\"extras\\\\\\": {},\\\\n \\\\\\"clusterId\\\\\\": \\\\\\"c39a1048921e04fceb039db2fb****\\\\\\",\\\\n \\\\\\"sourceName\\\\\\": \\\\\\"arms-luyao-test\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"167275301789****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"headers\\\\\\": {},\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"AlibabaPrometheus\\\\\\",\\\\n \\\\\\"extras\\\\\\": {},\\\\n \\\\\\"clusterId\\\\\\": \\\\\\"c6b6485496d5b400abde22cb47b5****\\\\\\",\\\\n \\\\\\"sourceName\\\\\\": \\\\\\"agent-321-测试\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"167275301789****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"headers\\\\\\": {},\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-zhangjiakou\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"AlibabaPrometheus\\\\\\",\\\\n \\\\\\"extras\\\\\\": {},\\\\n \\\\\\"clusterId\\\\\\": \\\\\\"c261a4f3200c446659133f1ade78****\\\\\\",\\\\n \\\\\\"sourceName\\\\\\": \\\\\\"zaifeng-cardinality-01\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"167275301789****\\\\\\"\\\\n }\\\\n]\\",\\n \\"RemoteReadIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteReadInterUrl\\": \\"http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteWriteIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"RemoteWriteInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"PushGatewayIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"PushGatewayInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"HttpApiIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx\\\\n\\",\\n \\"HttpApiInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx\\",\\n \\"AuthToken\\": \\"GciOiJIUzI1NiJ9***\\",\\n \\"PaymentType\\": \\"POSTPAY\\",\\n \\"GrafanaInstanceId\\": \\"grafana-rnggfvhlcdl6m71l**\\",\\n \\"ResourceGroupId\\": \\"rg-acfmz7nocpeidcy\\",\\n \\"ResourceType\\": \\"PROMETHEUS\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"ac-cus-tag-3\\",\\n \\"TagValue\\": \\"asg-2vc8qq7x89o11rus9uvu\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'ListPrometheusInstanceByTagAndResourceGroupId', - ], - 'CreatePrometheusInstance' => [ - 'summary' => 'Creates a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"ListAlerts\\": [\\n {\\n \\"AlertName\\": \\"告警测试\\",\\n \\"Severity\\": \\"P6\\",\\n \\"State\\": 0,\\n \\"DispatchRuleId\\": 12345,\\n \\"DispatchRuleName\\": \\"钉群通知\\",\\n \\"CreateTime\\": \\"2022-01-18 00:21:35\\",\\n \\"Activities\\": [\\n {\\n \\"Time\\": \\"2021-12-20 19:08:57\\",\\n \\"Type\\": 1,\\n \\"HandlerName\\": \\"运维A\\",\\n \\"Description\\": \\"[告警认领]认领了该告警\\",\\n \\"Content\\": \\"【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %\\"\\n }\\n ],\\n \\"AlertEvents\\": [\\n {\\n \\"AlertName\\": \\"测试触发的告警\\",\\n \\"Severity\\": \\"warning\\",\\n \\"State\\": \\"Active\\",\\n \\"StartTime\\": \\"2022-01-18 00:14:00\\",\\n \\"EndTime\\": \\"2022-01-19 17:10:31\\",\\n \\"ReceiveTime\\": \\"2022-01-19 17:05:42\\",\\n \\"IntegrationName\\": \\"ARMS\\",\\n \\"IntegrationType\\": \\"ARMS_APP_MON\\",\\n \\"GeneratorURL\\": \\"http://arms.console.aliyun.com\\",\\n \\"Description\\": \\"主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %\\",\\n \\"Annotations\\": \\"{ \\\\\\"_aliyun_arms_alert_value\\\\\\":\\\\\\"4.0\\\\\\" \\\\\\"_aliyun_arms_alert_traceId\\\\\\":\\\\\\"ac10c43116421327442277073d5461-105075299\\\\\\"}\\",\\n \\"Labels\\": \\"{ \\\\\\"severity\\\\\\":\\\\\\"warning\\\\\\" \\\\\\"_aliyun_arms_alert_level\\\\\\":\\\\\\"ERROR\\\\\\" \\\\\\"_aliyun_arms_entropy\\\\\\":\\\\\\"0.30170457417889235\\\\\\"}\\"\\n }\\n ],\\n \\"AlertId\\": 2279,\\n \\"Solution\\": \\"重启解决\\",\\n \\"Owner\\": \\"通知策略中配置的联系人通知对象\\",\\n \\"Handler\\": \\"认领、关闭告警的处理人\\",\\n \\"AcknowledgeTime\\": 0,\\n \\"RecoverTime\\": 0,\\n \\"NotifyRobots\\": \\"钉钉的名片。\\",\\n \\"Describe\\": \\"[告警通知]通过[webhook]通知了xxx(成功）\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"alert.manager.error.code.signature.invalid\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListAlerts', + 'changeSet' => [ + ['createdAt' => '2024-08-26T05:55:54.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-07-30T07:58:19.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-11T14:24:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-08T13:56:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-08T05:35:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-17T11:53:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-05-25T09:02:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-11T12:21:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-14T03:47:03.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlerts'], + ], ], + 'ramActions' => [], + ], + 'ListClusterFromGrafana' => [ + 'summary' => 'Queries all Grafana dashboards in a specified region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'abilityTreeCode' => '165691', - 'abilityTreeNodes' => [ - 'FEATUREarmsFRX7PL', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '国内Prometheus for 云服务：固定值cn-shanghai。'."\n" - .'其它类型的实例：实际regionId。', - 'description' => 'The ID of the region. If you use a Prometheus instance to monitor an Alibaba Cloud service in China, this parameter must be set to cn-shanghai.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shanghai', + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '6849D41E-EED4-5C00-89F9-6047BBD9DCB4', 'title' => ''], + 'PromClusterList' => [ + 'description' => 'The cluster information.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the Grafana dashboards.'."\n", + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The time when the dashboard was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2021-11-16T08:49:34Z', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the dashboard was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2021-12-09T02:05:04Z', 'title' => ''], + 'UserId' => ['description' => 'The ID of the Alibaba Cloud account to which the cluster belongs.'."\n", 'type' => 'string', 'example' => '1247285**', 'title' => ''], + 'Options' => ['description' => 'The custom parameter.'."\n", 'type' => 'string', 'example' => '{\'Option\': [\'betaTestApproved\']}', 'title' => ''], + 'IsControllerInstalled' => ['description' => 'Indicates whether the Prometheus agent was installed. Valid values:'."\n" + ."\n" + .'* true: The Prometheus agent was installed.'."\n" + .'* false: The Prometheus agent was not installed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AgentStatus' => ['description' => 'The status of the Prometheus agent on the cluster. Valid values:'."\n" + ."\n" + .'* INSTALL_FAILED: The Prometheus agent failed to be installed.'."\n" + .'* INSTALL_SUCCEED: The Prometheus agent was installed.'."\n" + .'* NOT_REGISTER: You have not registered an Alibaba Cloud account.'."\n", 'type' => 'string', 'example' => 'INSTALL_FAILED', 'title' => ''], + 'Extra' => ['description' => 'The extended fields. This parameter is a JSON string.'."\n", 'type' => 'string', 'example' => '{\\"app_id\\":\\"bbd\\",\\"task_id\\":\\"4305ba5bf14942daa6e553ed91f46988\\"}', 'title' => ''], + 'InstallTime' => ['description' => 'The timestamp when the Prometheus agent was installed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1653532518000', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'ControllerId' => ['description' => 'The controller ID.'."\n", 'type' => 'string', 'example' => '1092', 'title' => ''], + 'PluginsJsonArray' => ['description' => 'The list of nodejsonar logs.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'ClusterType' => ['description' => 'The type of the cluster.'."\n", 'type' => 'string', 'example' => 'cloud-product-prometheus', 'title' => ''], + 'ClusterName' => ['description' => 'The name of the cluster.'."\n", 'type' => 'string', 'example' => 'ay-ads-hangzhou', 'title' => ''], + 'StateJson' => ['description' => 'The information about applications deployed in the cluster.'."\n", 'type' => 'string', 'example' => '{}', 'title' => ''], + 'LastHeartBeatTime' => ['description' => 'The time when the last heartbeat was reported.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1653532518000', 'title' => ''], + 'NodeNum' => ['description' => 'The number of nodes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'Id' => ['description' => 'The ID of a database in the cluster.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16136', 'title' => ''], + 'ClusterId' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'c0df7ad9db0ed43128925ca04774c469e', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"6849D41E-EED4-5C00-89F9-6047BBD9DCB4\\",\\n \\"PromClusterList\\": [\\n {\\n \\"UpdateTime\\": 0,\\n \\"CreateTime\\": 0,\\n \\"UserId\\": \\"1247285**\\",\\n \\"Options\\": \\"{\'Option\': [\'betaTestApproved\']}\\",\\n \\"IsControllerInstalled\\": true,\\n \\"AgentStatus\\": \\"INSTALL_FAILED\\",\\n \\"Extra\\": \\"{\\\\\\\\\\\\\\"app_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"bbd\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"task_id\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"4305ba5bf14942daa6e553ed91f46988\\\\\\\\\\\\\\"}\\",\\n \\"InstallTime\\": 1653532518000,\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"ControllerId\\": \\"1092\\",\\n \\"PluginsJsonArray\\": \\"{}\\",\\n \\"ClusterType\\": \\"cloud-product-prometheus\\",\\n \\"ClusterName\\": \\"ay-ads-hangzhou\\",\\n \\"StateJson\\": \\"{}\\",\\n \\"LastHeartBeatTime\\": 1653532518000,\\n \\"NodeNum\\": 3,\\n \\"Id\\": 16136,\\n \\"ClusterId\\": \\"c0df7ad9db0ed43128925ca04774c469e\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListClusterFromGrafanaResponse>\\n <RequestId>6849D41E-EED4-5C00-89F9-6047BBD9DCB4</RequestId>\\n <PromClusterList>\\n <UserId>1247285**</UserId>\\n <Options>{\'Option\': [\'betaTestApproved\']}</Options>\\n <IsControllerInstalled>true</IsControllerInstalled>\\n <AgentStatus>INSTALL_FAILED</AgentStatus>\\n <Extra>{\\\\\\"app_id\\\\\\":\\\\\\"bbd\\\\\\",\\\\\\"task_id\\\\\\":\\\\\\"4305ba5bf14942daa6e553ed91f46988\\\\\\"}</Extra>\\n <InstallTime>1653532518000</InstallTime>\\n <RegionId>cn-beijing</RegionId>\\n <ControllerId>1092</ControllerId>\\n <PluginsJsonArray>{}</PluginsJsonArray>\\n <ClusterType>cloud-product-prometheus</ClusterType>\\n <ClusterName>ay-ads-hangzhou</ClusterName>\\n <StateJson>{}</StateJson>\\n <LastHeartBeatTime>1653532518000</LastHeartBeatTime>\\n <NodeNum>3</NodeNum>\\n <Id>16136</Id>\\n <ClusterId>c0df7ad9db0ed43128925ca04774c469e</ClusterId>\\n </PromClusterList>\\n</ListClusterFromGrafanaResponse>","errorExample":""}]', + 'title' => 'ListClusterFromGrafana', + 'changeSet' => [ + ['createdAt' => '2023-03-23T08:07:27.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusterFromGrafana'], + ], + ], + 'ramActions' => [], + ], + 'ListCmsInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClusterType', - 'in' => 'query', - 'schema' => [ - 'title' => '类型：'."\n" - .' remote-write（Prometheus for Remote Write）'."\n" - .' ecs（Prometheus for ECS）'."\n" - .' global-view（Prometheus for GlobalView）'."\n" - .' aliyun-cs'."\0\0".'（Prometheus for 容器服务）', - 'description' => 'The type of the Prometheus instance. Valid values:'."\n" - ."\n" - .'* remote-write: Prometheus instance for Remote Write'."\n" - .'* ecs (unavailable): Prometheus instance for ECS'."\n" - .'* global-view: Prometheus instance for GlobalView'."\n" - .'* aliyun-cs: Prometheus instance for Container Service'."\n" - .'* cloud-product (unavailable): Prometheus instance for Alibaba Cloud services'."\n" - .'* cloud-monitor (unavailable): Prometheus instance for Hybrid Cloud Monitoring'."\n" - .'* flink (unavailable): Prometheus instance for Flink'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'remote-write', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'VpcId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '当clusterType为ecs或者创建托管版ask容器集群时，需要传此参数：用户专有网络VPC', - 'description' => 'The ID of virtual private cloud (VPC). This parameter is required if you set the ClusterType parameter to ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-rpn**********', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'VSwitchId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '当clusterType为ecs或者创建托管版ask容器集群时，需要传此参数：用户专有网络交换机VSwitch', - 'description' => 'The ID of the vSwitch. This parameter is required if you set the ClusterType parameter to ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'vsw-bp1*********', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'n9p9o9o3se', 'title' => ''], ], [ - 'name' => 'SecurityGroupId', + 'name' => 'TypeFilter', 'in' => 'query', 'schema' => [ - 'title' => '当clusterType为ecs或者创建托管版ask容器集群时，需要传此参数：用户专有网络安全组SecurityGroup', - 'description' => 'The ID of the security group. This parameter is required if you set the ClusterType parameter to ecs.'."\n", + 'description' => 'The type of integrated cloud service. Valid values:'."\n" + ."\n" + .'- `direct`: An integration for cloud products that are monitored by the product itself.'."\n" + ."\n" + .'- `cms`: An integration with CloudMonitor.', 'type' => 'string', 'required' => false, - 'docRequired' => false, - 'example' => 'sg-bp1********', + 'docRequired' => true, + 'enum' => ['cms', 'direct'], + 'example' => 'direct', + 'title' => '', ], ], - [ - 'name' => 'ClusterId', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '当clusterType为aliyun-cs时，需要传此参数：用户容器服务集群ID', - 'description' => 'The ID of the ACK cluster. This parameter is required if you set the ClusterType parameter to aliyun-cs.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + 'title' => 'Schema of Response', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1'], + 'Data' => [ + 'description' => 'The returned data.', + 'type' => 'object', + 'properties' => [ + 'EnableTag' => ['description' => 'Indicates whether tag collection for the cloud product is enabled.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Products' => [ + 'description' => 'The list of cloud products.', + 'type' => 'array', + 'items' => [ + 'description' => 'A cloud product.', + 'type' => 'object', + 'properties' => [ + 'Descr' => ['description' => 'The product description.', 'type' => 'string', 'example' => '-'."\n", 'title' => ''], + 'Instance' => ['description' => 'The instance name.', 'type' => 'string', 'example' => 'cloudserver', 'title' => ''], + 'Prod' => ['description' => 'The product code.', 'type' => 'string', 'example' => 'face', 'title' => ''], + 'Name' => ['description' => 'The name of the integrated cloud product.', 'type' => 'string', 'example' => 'hologres', 'title' => ''], + 'Id' => ['description' => 'The instance ID.', 'type' => 'string', 'example' => '20210', 'title' => ''], + 'State' => ['description' => 'The integration status of the product.'."\n" + ."\n" + .'- `true`: Integrated.'."\n" + ."\n" + .'- `false`: Not integrated.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Time' => ['description' => 'The creation timestamp of the Grafana dashboard.', 'type' => 'string', 'example' => '1647852021000', 'title' => ''], + 'Type' => ['description' => 'The product type.', 'type' => 'string', 'example' => 'HOLOGRES', 'title' => ''], + 'Url' => ['description' => 'The complete URL of the Grafana dashboard.', 'type' => 'string', 'example' => 'https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\u003d9\\u0026refresh\\u003d60s', 'title' => ''], + 'Source' => ['description' => 'The event source.', 'type' => 'string', 'example' => 'arms', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'Query the collection status of Alibaba Cloud services ', + 'summary' => 'Queries the data collection status of cloud services.', + 'changeSet' => [ + ['createdAt' => '2022-09-01T02:43:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-16T06:18:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-22T09:39:44.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCmsInstances'], + ], + ], + 'ramActions' => [ [ - 'name' => 'ClusterName', - 'in' => 'query', - 'schema' => [ - 'title' => '当clusterType为remote-write、ecs、global-view时，需要传此参数：用户新建集群的名称。'."\n" - .'ecs类型实例时，ClusterName的命名规则“name-vpc-id”，且name长度不允许超过24个字符。如“mytest1-vpc-xxxxxxxxxxx”。', - 'description' => 'The name of the created cluster. This parameter is required if you set the ClusterType parameter to remote-write or ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'clusterNameOfTest', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListCmsInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1\\",\\n \\"Data\\": {\\n \\"EnableTag\\": true,\\n \\"Products\\": [\\n {\\n \\"Descr\\": \\"-\\\\n\\",\\n \\"Instance\\": \\"cloudserver\\",\\n \\"Prod\\": \\"face\\",\\n \\"Name\\": \\"hologres\\",\\n \\"Id\\": \\"20210\\",\\n \\"State\\": \\"true\\",\\n \\"Time\\": \\"1647852021000\\",\\n \\"Type\\": \\"HOLOGRES\\",\\n \\"Url\\": \\"https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\\\\\\\u003d9\\\\\\\\u0026refresh\\\\\\\\u003d60s\\",\\n \\"Source\\": \\"arms\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'ListDashboards' => [ + 'summary' => 'Queries the Grafana dashboards of a Container Service for Kubernetes (ACK) cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'SubClustersJson', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '当clusterType为global-view时，需要传此参数：需要聚合的集群的信息列表；示例：[{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73ede6","sourceName":"arms-luyao-test","dataSource":"","userId":"1672753017899339"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5d790f","sourceName":"agent-321-测试","dataSource":"","userId":"1672753017899339"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"1672753017899339"}]', - 'description' => 'JSON string for child instances of the globalView instance.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'When the clusterType is global view, this parameter needs to be passed: a list of information about the clusters that need to be aggregated.'."\n" - .'Example:'."\n" - .'['."\n" - .' {'."\n" - .' "Headers":{'."\n" - ."\n" - .' },'."\n" - .' "RegionId": "cn hangzhou",'."\n" - .' "SourceType": "Alibaba Prometheus",'."\n" - .' "Extras":{'."\n" - ."\n" - .' },'."\n" - .' "ClusterId": "c39a1048921e04f ****************",'."\n" - .' "SourceName": "test1",'."\n" - .' "DataSource": "",'."\n" - .' "UserId": "1672753 ******************"'."\n" - .' },'."\n" - .' {'."\n" - .' "Headers":{'."\n" - ."\n" - .' },'."\n" - .' "RegionId": "cn beijing",'."\n" - .' "SourceType": "Alibaba Prometheus",'."\n" - .' "Extras":{'."\n" - ."\n" - .' },'."\n" - .' "ClusterId": "c6b6485496d5b40 ****************",'."\n" - .' "SourceName": "test2",'."\n" - .' "DataSource": "",'."\n" - .' "UserId": "1672753 ******************"'."\n" - .' },'."\n" - .' {'."\n" - .' "Headers":{'."\n" - ."\n" - .' },'."\n" - .' "RegionId": "cn zhangjiakou",'."\n" - .' "SourceType": "Alibaba Prometheus",'."\n" - .' "Extras":{'."\n" - ."\n" - .' },'."\n" - .' "ClusterId": "c261a4f3200c446 ****************",'."\n" - .' "SourceName": "test3",'."\n" - .' "DataSource": "",'."\n" - .' "UserId": "1672753 ******************"'."\n" - .' }'."\n" - .']', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AllSubClustersSuccess', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'title' => '创建GlobalView时，是否要求所有子实例都校验成功时，才创建GlobalView实例。后台默认是false，即可以部分成功。', - 'description' => 'Does it require all child instances to be verified successfully before creating a GlobalView instance. The default is false, which means partial success is possible.', - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The ID of the ACK cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'GrafanaInstanceId', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'title' => 'Grafana工作区ID；共享版Grafana时，填"free"。', - 'description' => 'The ID of the Grafana dedicated instance. This parameter is available if you set the ClusterType parameter to ecs.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'grafana-bp1*****', - ], + 'schema' => ['description' => 'Valid values: ACK, ASK, cloud-product-prometheus, and Node. You can query the dashboards of a virtual cluster by specifying the cluster type. For InfluxDB, set this parameter to `cloud-product-prometheus`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Node', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Language', 'in' => 'query', - 'schema' => [ - 'title' => '用户资源组ID', - 'description' => 'The ID of the custom resource group. You can configure this parameter to bind the instance to the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The language of the returned Grafana dashboard. Valid values: en and zh. Default value: en.'."\n", 'type' => 'string', 'required' => false, 'example' => 'en', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'Title', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'title' => '可以传此参数，给实例创建标签进行管理', - 'description' => 'The tags of the instance. You can configure this parameter to manage tags for the instance.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '标签名', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'title' => '标签值', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'example' => '['."\n" - .' {'."\n" - .' "labelName":"labelValue"'."\n" - .' },'."\n" - .' {'."\n" - .' "testName":"clusterA"'."\n" - .' }'."\n" - .']', - 'maxItems' => 21, - ], + 'schema' => ['description' => 'The dashboard title. The dashboard title can be changed. We recommend that you specify the **DashboardName** parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ApiServer', 'title' => ''], ], [ - 'name' => 'Duration', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'title' => '存储时长（天）。', - 'description' => 'The data storage duration. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The cloud service code. This parameter is required if you set the ClusterType parameter to `cloud-product-prometheus`. The following cloud services are available: Serverless App Engine, Microservices Engine, Message Queue for Apache RocketMQ, Lindorm, Message Queue for Apache Kafka, ApsaraDB for ClickHouse, Data Lake Analytics, Message Queue for RabbitMQ, ApsaraDB for MongoDB, Time Series Database (TSDB) for InfluxDB, MSE Cloud-native Gateway, Grafana Service, SchedulerX, Global Transaction Service, Enterprise Distributed Application Service, Machine Learning Platform for AI - Elastic Algorithm Service (EAS), Application High Availability Service, and Performance Testing.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxxx', 'title' => ''], ], [ - 'name' => 'ArchiveDuration', + 'name' => 'RecreateSwitch', 'in' => 'query', - 'schema' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：60、90、180、365天。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => 'The number of days for which data is automatically archived after the storage expires. Valid values: 60, 90, 180, and 365. 0 indicates that the data is not archived.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'PaymentType', + 'name' => 'DashboardName', 'in' => 'query', - 'schema' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。'."\n" - .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', - 'description' => 'The billing mode. Valid values: POSTPAY: charges fees based on the amount of reported metric data. POSTPAY_GB: charges fees based on the amount of written metric data. Empty: The user-defined default billing mode is used. If you do not specify a default value, you are charged based on the amount of reported metric data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY', - 'enum' => [ - 'POSTPAY', - 'POSTPAY_GB', - ], - ], + 'schema' => ['description' => 'The unique names of the dashboards. You can query dashboards by specifying their names. The **dashboard title** can be changed whereas the **dashboard name** cannot. You can specify multiple names and separate them with commas (,), for example, `k8s-event,k8s-overview`. A dashboard may have multiple versions. If you want to specify a version, you can add version information after the name, for example, `k8s-event:v1,k8s-overview:latest`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'k8s-node-overview', 'title' => ''], ], ], 'responses' => [ @@ -24671,435 +19570,468 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Data' => [ - 'title' => '集群id', - 'description' => 'The ID of the created Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'qduukd****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '70675725-8F11-4817-8106-CFE0AD71****', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', 'title' => ''], + 'DashboardVos' => [ + 'description' => 'The information about the Grafana dashboard.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the Grafana dashboard.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the Grafana dashboard. Valid values:'."\n" + ."\n" + .'* `dash-db`: a dashboard'."\n" + .'* `dash-folder`: a folder that can include a dashboard'."\n", 'type' => 'string', 'example' => 'dash-db', 'title' => ''], + 'Time' => ['description' => 'The time when the Grafana dashboard was created. The value is a timestamp. Unit: seconds.'."\n", 'type' => 'string', 'example' => '1590136924', 'title' => ''], + 'NeedUpdate' => ['description' => 'Indicates whether the Grafana dashboard has a new version that is available for upgrade.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Kind' => ['description' => 'The category of the Grafana dashboard. Valid values: BASIC, THIRD, LIMIT, and CUSTOM.'."\n", 'type' => 'string', 'example' => 'BASIC', 'title' => ''], + 'Language' => ['description' => 'The language of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'en', 'title' => ''], + 'Url' => ['description' => 'The complete URL of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', 'title' => ''], + 'HttpsUrl' => ['description' => 'The URL of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', 'title' => ''], + 'DashboardType' => ['description' => 'The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication.'."\n", 'type' => 'string', 'example' => 'Node', 'title' => ''], + 'Exporter' => ['description' => 'The type of the exporter access source. Valid values:'."\n" + ."\n" + .'* Prometheus'."\n" + .'* Node'."\n" + .'* GPU'."\n" + .'* Redis'."\n" + .'* MySQL'."\n" + .'* Kafka'."\n" + .'* NGINX V2'."\n" + .'* Nginx'."\n" + .'* ZooKeeper'."\n" + .'* MongoDB'."\n" + .'* RabbitMQ'."\n" + .'* PostgreSQL'."\n" + .'* Kubernetes'."\n" + .'* Client Library'."\n" + .'* Elasticsearch'."\n" + .'* RocketMQ'."\n", 'type' => 'string', 'example' => 'Nginx', 'title' => ''], + 'Version' => ['description' => 'The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard.'."\n", 'type' => 'string', 'example' => 'v2', 'title' => ''], + 'IsArmsExporter' => ['description' => 'Indicates whether the exporter is provided by Application Real-Time Monitoring Service (ARMS).'."\n" + ."\n" + .'* `true:` The exporter is provided by ARMS.'."\n" + .'* `false:`: The exporter is not provided by ARMS.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'HttpUrl' => ['description' => 'The URL of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', 'title' => ''], + 'Title' => ['description' => 'The title of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'ApiServer', 'title' => ''], + 'Name' => ['description' => 'The name of the Grafana dashboard. This parameter is different from the **Title** parameter as this parameter cannot be changed.'."\n", 'type' => 'string', 'example' => 'k8s-node-overview', 'title' => ''], + 'Id' => ['description' => 'The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard.'."\n", 'type' => 'string', 'example' => '1100**', 'title' => ''], + 'Uid' => ['description' => 'The unique identifier of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => '1131971649496228-*****-59', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags of the Grafana dashboard.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tags of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => '["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'I18nChild' => [ + 'description' => 'The information about the Grafana dashboard.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the Grafana dashboard. Valid values:'."\n" + ."\n" + .'* `dash-db`: a dashboard'."\n" + .'* `dash-folder`: a folder that can include a dashboard'."\n", 'type' => 'string', 'example' => 'dash-db', 'title' => ''], + 'Time' => ['description' => 'The time when the Grafana dashboard was created. The value is a timestamp.'."\n", 'type' => 'string', 'example' => '1590136924', 'title' => ''], + 'NeedUpdate' => ['description' => 'Indicates whether the Grafana dashboard has a new version that is available for upgrade.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Kind' => ['description' => 'The category of the Grafana dashboard. Valid values: BASIC, THIRD, LIMIT, and CUSTOM.'."\n", 'type' => 'string', 'example' => 'BASIC', 'title' => ''], + 'Language' => ['description' => 'The language of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'Url' => ['description' => 'The complete URL of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', 'title' => ''], + 'HttpsUrl' => ['description' => 'The URL of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', 'title' => ''], + 'DashboardType' => ['description' => 'The type of the Grafana dashboard. This parameter has the same effect as the Exporter parameter whereas provides clearer implication.'."\n", 'type' => 'string', 'example' => 'Node', 'title' => ''], + 'Exporter' => ['description' => 'The type of the exporter access source. Valid values:'."\n" + ."\n" + .'* Prometheus'."\n" + .'* Node'."\n" + .'* GPU'."\n" + .'* Redis'."\n" + .'* MySQL'."\n" + .'* Kafka'."\n" + .'* NGINX V2'."\n" + .'* Nginx'."\n" + .'* ZooKeeper'."\n" + .'* MongoDB'."\n" + .'* RabbitMQ'."\n" + .'* PostgreSQL'."\n" + .'* Kubernetes'."\n" + .'* Client Library'."\n" + .'* Elasticsearch'."\n" + .'* RocketMQ'."\n", 'type' => 'string', 'example' => 'Nginx', 'title' => ''], + 'Version' => ['description' => 'The version of the Grafana dashboard. The combination of version and name uniquely identifies a dashboard.'."\n", 'type' => 'string', 'example' => 'v2', 'title' => ''], + 'IsArmsExporter' => ['description' => 'Indicates whether the exporter is provided by ARMS.'."\n" + ."\n" + .'* `true:` The exporter is provided by ARMS.'."\n" + .'* `false:`: The exporter is not provided by ARMS.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'HttpUrl' => ['description' => 'The URL of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', 'title' => ''], + 'Title' => ['description' => 'The title of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'ApiServer', 'title' => ''], + 'Name' => ['description' => 'The name of the Grafana dashboard. This parameter is different from the **Title** parameter as this parameter cannot be changed.'."\n", 'type' => 'string', 'example' => 'k8s-node-overview', 'title' => ''], + 'Id' => ['description' => 'The ID of the Grafana dashboard. The value is unique only when you install the Grafana dashboard.'."\n", 'type' => 'string', 'example' => '1100**', 'title' => ''], + 'Uid' => ['description' => 'The unique identifier of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => '1131971649496228-*****-59', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags of the Grafana dashboard.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tags of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => '["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'PrometheusServiceOpened' => ['description' => 'Whether or not to turn on Prometheus service.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'EnvironmentId' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'example' => 'env-ebd54733482581fc8c4237******', 'title' => ''], + 'GrafanaServiceOpened' => ['description' => 'Indicates whether Managed Service for Grafana is activated.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"qduukd****\\",\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'CreatePrometheusInstance', - ], - 'UpdatePrometheusInstance' => [ - 'summary' => 'Updates the information about a Prometheus instance.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"DashboardVos\\": [\\n {\\n \\"Type\\": \\"dash-db\\",\\n \\"Time\\": \\"1590136924\\",\\n \\"NeedUpdate\\": false,\\n \\"Kind\\": \\"BASIC\\",\\n \\"Language\\": \\"en\\",\\n \\"Url\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"HttpsUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"DashboardType\\": \\"Node\\",\\n \\"Exporter\\": \\"Nginx\\",\\n \\"Version\\": \\"v2\\",\\n \\"IsArmsExporter\\": false,\\n \\"HttpUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"Title\\": \\"ApiServer\\",\\n \\"Name\\": \\"k8s-node-overview\\",\\n \\"Id\\": \\"1100**\\",\\n \\"Uid\\": \\"1131971649496228-*****-59\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"arms-k8s\\\\\\",\\\\\\"ccc8ce1fe0c9543629e39ee657e34****\\\\\\"]\\"\\n ],\\n \\"I18nChild\\": {\\n \\"Type\\": \\"dash-db\\",\\n \\"Time\\": \\"1590136924\\",\\n \\"NeedUpdate\\": false,\\n \\"Kind\\": \\"BASIC\\",\\n \\"Language\\": \\"zh\\",\\n \\"Url\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"HttpsUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"DashboardType\\": \\"Node\\",\\n \\"Exporter\\": \\"Nginx\\",\\n \\"Version\\": \\"v2\\",\\n \\"IsArmsExporter\\": false,\\n \\"HttpUrl\\": \\"http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s\\",\\n \\"Title\\": \\"ApiServer\\",\\n \\"Name\\": \\"k8s-node-overview\\",\\n \\"Id\\": \\"1100**\\",\\n \\"Uid\\": \\"1131971649496228-*****-59\\",\\n \\"Tags\\": [\\n \\"[\\\\\\"arms-k8s\\\\\\",\\\\\\"ccc8ce1fe0c9543629e39ee657e34****\\\\\\"]\\"\\n ]\\n }\\n }\\n ],\\n \\"PrometheusServiceOpened\\": \\"true\\",\\n \\"EnvironmentId\\": \\"env-ebd54733482581fc8c4237******\\",\\n \\"GrafanaServiceOpened\\": \\"true\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDashboardsResponse>\\n <RequestId>2A0CEDF1-06FE-44AC-8E21-21A5BE65****</RequestId>\\n <DashboardVos>\\n <Type>dash-db</Type>\\n <Time>1590136924</Time>\\n <NeedUpdate>false</NeedUpdate>\\n <Kind>BASIC</Kind>\\n <Url>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s</Url>\\n <HttpsUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s</HttpsUrl>\\n <DashboardType>Node</DashboardType>\\n <Exporter>Nginx</Exporter>\\n <Version>v2</Version>\\n <IsArmsExporter>false</IsArmsExporter>\\n <HttpUrl>http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s</HttpUrl>\\n <Title>ApiServer</Title>\\n <Name>k8s-node-overview</Name>\\n <Id>1100**</Id>\\n <Uid>1131971649496228-*****-59</Uid>\\n <Tags>[\\"arms-k8s\\",\\"ccc8ce1fe0c9543629e39ee657e34****\\"]</Tags>\\n </DashboardVos>\\n</ListDashboardsResponse>","errorExample":""}]', + 'title' => 'ListDashboards', + 'description' => 'None.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-04-02T02:16:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-12-14T07:25:42.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-30T02:31:00.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-01-09T02:50:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-25T11:58:52.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-11-25T11:58:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-25T11:58:52.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-25T11:58:52.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDashboards'], + ], ], + 'ramActions' => [], + ], + 'ListDashboardsByName' => [ + 'summary' => 'Uses Loki data sources and other data sources to create a Grafana dashboard in Managed Service for Prometheus.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '217860', - 'abilityTreeNodes' => [ - 'FEATUREarmsFRX7PL', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例的资源组id', - 'description' => 'The ID of the Prometheus resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'title' => 'prometheus实例ID', - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'vpc-xxx', - ], + 'schema' => ['description' => 'The ID of the cluster. If the ClusterType parameter is not set to `cloud-product-prometheus` or `cms-enterprise-prometheus`, you must specify the ClusterId parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'StorageDuration', + 'name' => 'DataSourceType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '数据保存时长（天）。', - 'description' => 'The data storage duration. Unit: days.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The type of the data source. Valid values:'."\n" + ."\n" + .'* loki'."\n" + .'* prometheus'."\n", 'type' => 'string', 'required' => false, 'example' => 'loki', 'title' => ''], ], [ - 'name' => 'ArchiveDuration', + 'name' => 'ClusterType', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" - .'V1：60、90、180、365天。'."\n" - .'V2：1~3650天（3650表示永久保存）。', - 'description' => 'The number of days for which data is automatically archived after the storage expires. Valid values: 60, 90, 180, and 365. 0 indicates that the data is not archived.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '90', - ], + 'schema' => ['description' => 'The cluster type. Valid values:'."\n" + ."\n" + .'* vpc-prometheus'."\n" + .'* cloud-product-prometheus'."\n" + .'* cms-enterprise-prometheus'."\n" + .'* ExternalKubernetes'."\n" + .'* Ask'."\n" + .'* Kubernetes'."\n" + .'* ManagedKubernetes'."\n" + .'* remote-write-prometheus'."\n" + .'* GlobalViewV2'."\n", 'type' => 'string', 'required' => false, 'example' => 'cloud-product-prometheus', 'title' => ''], ], [ - 'name' => 'EnableAuthToken', + 'name' => 'ProductCode', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启访问Token鉴权', - 'description' => 'Specifies whether to enable access token authentication.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'The abbreviation of the Alibaba Cloud service name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'edas', 'title' => ''], ], [ - 'name' => 'EnableAuthFreeRead', + 'name' => 'GroupName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启免密读', - 'description' => 'Specifies whether to enable password-free read.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the dashboard group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'EDAS', 'title' => ''], ], [ - 'name' => 'AuthFreeReadPolicy', - 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启免密读的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', - 'description' => 'The IP addresses or CIDR blocks for which password-free read is enabled. Separate multiple IP addresses with line breaks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], - ], - [ - 'name' => 'EnableAuthFreeWrite', + 'name' => 'DashBoardName', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启免密写', - 'description' => 'Specifies whether to enable password-free write.'."\n", - 'type' => 'boolean', - 'required' => false, - ], + 'schema' => ['description' => 'The name of the dashboard.'."\n", 'type' => 'string', 'required' => false, 'example' => 'edas-ingress-url', 'title' => ''], ], [ - 'name' => 'AuthFreeWritePolicy', + 'name' => 'DashBoardVersion', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'title' => '是否开启免密写的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', - 'description' => 'The IP addresses or CIDR blocks for which password-free write is enabled. Separate multiple IP addresses with line breaks.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0.0.0.0/0', - ], + 'schema' => ['description' => 'The version of the dashboard.'."\n", 'type' => 'string', 'required' => false, 'example' => 'latest', 'title' => ''], ], [ - 'name' => 'PaymentType', + 'name' => 'OnlyQuery', 'in' => 'query', - 'schema' => [ - 'title' => '计费方式：'."\n" - .'POSTPAY：按指标上报量后付费。'."\n" - .'POSTPAY_GB：按指标写入量后付费。', - 'description' => 'The billing mode. Valid values: POSTPAY: charges fees based on the amount of reported metric data. POSTPAY_GB: charges fees based on the amount of written metric data.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POSTPAY', - 'enum' => [ - 'POSTPAY', - 'POSTPAY_GB', - ], - ], + 'schema' => ['description' => 'Specifies whether to display the Grafana dashboard only in the Application Real-Time Monitoring Service (ARMS) console.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response schema.'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', - ], - 'Data' => [ - 'description' => 'The result of the operation.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The returned status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Data' => ['description' => 'The returned struct.'."\n", 'type' => 'string', 'example' => '[{"name":"Edas Ingress Url Analysis","type":"edas-ingress-url-analysis","url":"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou"}]', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request, You can use the ID to locate logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', 'title' => ''], + 'Code' => ['description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'UpdatePrometheusInstance', - ], - 'UpdatePrometheusGlobalView' => [ - 'summary' => 'Updates the data sources of Prometheus instance for GlobalView.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'title' => 'ListDashboardsByName', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-06-27T02:21:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-06-10T08:29:55.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDashboardsByName'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[{\\\\\\"name\\\\\\":\\\\\\"Edas Ingress Url Analysis\\\\\\",\\\\\\"type\\\\\\":\\\\\\"edas-ingress-url-analysis\\\\\\",\\\\\\"url\\\\\\":\\\\\\"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou\\\\\\"}]\\",\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<ListDashboardsByNameResponse>\\n <Data>[{\\"name\\":\\"Edas Ingress Url Analysis\\",\\"type\\":\\"edas-ingress-url-analysis\\",\\"url\\":\\"https://g.console.aliyun.com/d/1036052989950239-11040375-66-3/edas-ingress-url-analysis?var-clusterId=29ksa&var-regionId=cn-hangzhou\\"}]</Data>\\n <RequestId>2983BEF7-4A0D-47A2-94A2-8E9C5E63****</RequestId>\\n</ListDashboardsByNameResponse>","errorExample":""}]', + ], + 'ListDispatchRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => true, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the Prometheus instance resides.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-shenzhen', - ], + 'schema' => ['description' => 'The name of the notification policy. Fuzzy match is supported.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Prod', 'title' => ''], ], [ - 'name' => 'GroupName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'zyGlobalView', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MostRegionId', + 'name' => 'System', 'in' => 'query', + 'schema' => ['description' => '* The type of notification policies to be queried. Valid values: `false` (default): notification policies created in Application Real-Time Monitoring Service (ARMS).'."\n" + .'* `true`: notification policies created in an external system.'."\n" + ."\n" + .'> You cannot use the ARMS console to modify the dispatch rules of a notification policy that is created in an external system.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The region ID of the global aggregation instance.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3**** ', 'title' => ''], + 'DispatchRules' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => 'Prod', 'title' => ''], + 'State' => ['description' => 'Indicates whether the notification policy is enabled. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RuleId' => ['description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10282', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\\\t\\",\\n \\"DispatchRules\\": [\\n {\\n \\"Name\\": \\"Prod\\",\\n \\"State\\": \\"true\\",\\n \\"RuleId\\": 10282\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDispatchRuleResponse>\\n<RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****\\t</RequestId>\\n<DispatchRules>\\n <State>true</State>\\n <RuleId>10282</RuleId>\\n <Name>Prod</Name>\\n</DispatchRules>\\n</ListDispatchRuleResponse>","errorExample":""}]', + 'title' => 'ListDispatchRule', + 'summary' => 'Queries notification policies.', + 'description' => 'The current API operation is no longer maintained. To query the notification policy information, call the ListNotificationPolicies operation instead.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T06:25:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListEnvCustomJobs' => [ + 'summary' => 'Queries the custom jobs of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'global****', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'ResourceGroupId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'prometheus实例的资源组id', - 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SubClustersJson', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '聚合的集群的信息列表；示例：[{"headers":{},"regionId":"cn-hangzhou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c39a1048921e04fceb039db2fbb73ede6","sourceName":"arms-luyao-test","dataSource":"","userId":"1672753017899339"},{"headers":{},"regionId":"cn-beijing","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c6b6485496d5b400abde22cb47b5d790f","sourceName":"agent-321-测试","dataSource":"","userId":"1672753017899339"},{"headers":{},"regionId":"cn-zhangjiakou","sourceType":"AlibabaPrometheus","extras":{},"clusterId":"c261a4f3200c446659133f1ade789b15e","sourceName":"zaifeng-cardinality-01","dataSource":"","userId":"1672753017899339"}]', - 'description' => 'The data sources of the Prometheus instance for GlobalView.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[ { "headers":{ }, "regionId":"cn-hangzhou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c39a1048921e04f***********", "sourceName":"arms-luyao-test", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-beijing", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c6b6485496d5b40***********", "sourceName":"agent-321-test", "dataSource":"", "userId":"1672753***********" }, { "headers":{ }, "regionId":"cn-zhangjiakou", "sourceType":"AlibabaPrometheus", "extras":{ }, "clusterId":"c261a4f3200c446***********", "sourceName":"zaifeng-cardinality-01", "dataSource":"", "userId":"1672753***********" } ]'."\n", - ], + 'schema' => ['description' => 'The ID of the environment instance.', 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ - 'name' => 'AllSubClustersSuccess', + 'name' => 'EncryptYaml', 'in' => 'query', - 'schema' => [ - 'title' => '创建GlobalView时，是否要求所有子实例都校验成功时，才创建GlobalView实例。后台默认是false，即可以部分成功。', - 'description' => 'To edit a GlobalView aggregated instance, do you require all passed child instances to be verified successfully before creating a GlobalView instance (optional, default to false):'."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'true', - ], + 'allowEmptyValue' => true, + 'schema' => ['description' => 'Specifies whether to return the encrypted YAML string.', 'type' => 'boolean', 'docRequired' => false, 'title' => '', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'FailedInstances' => [ - 'description' => 'The data sources that failed to be updated.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'SourceName' => [ - 'description' => 'The name of the data source.'."\n", - 'type' => 'string', - 'example' => 'sourcename-test', - ], - 'SourceType' => [ - 'title' => 'AlibabaPrometheus'."\n" - .'MetricStore'."\n" - .'CustomPrometheus', - 'description' => 'The type of the data source. AlibabaPrometheus MetricStore CustomPrometheus'."\n", - 'type' => 'string', - 'example' => 'AlibabaPrometheus', - ], - 'UserId' => [ - 'description' => 'The user ID.'."\n", - 'type' => 'string', - 'example' => '23784673825*******', - ], - 'ClusterId' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'example' => 'cdb65ed2d527345*********', + 'description' => 'The returned struct.', + 'type' => 'array', + 'items' => [ + 'description' => 'The data returned.', + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => ['description' => 'The ID of the environment instance.', 'type' => 'string', 'example' => 'env-xxxx', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'CustomJobName' => ['description' => 'The name of the custom job.', 'type' => 'string', 'example' => 'job1', 'title' => ''], + 'ConfigYaml' => ['description' => 'If the request parameter EncryptYaml is set to true, a Base64-encoded YAML string is returned. Otherwise, a plaintext YAML string is returned.', 'type' => 'string', 'title' => '', 'example' => '参见补充说明。'], + 'Status' => ['description' => 'The status of the custom job.', 'type' => 'string', 'example' => 'run', 'title' => ''], + 'CreationTimestamp' => ['description' => 'The time when the custom job was created. The value of this parameter is a timestamp.', 'type' => 'string', 'example' => '2022-01-01T10:11:34Z', 'title' => ''], + 'AddonName' => ['description' => 'The name of the add-on to which the custom job belongs.', 'type' => 'string', 'title' => '', 'example' => 'mysql'], + 'AddonReleaseName' => ['description' => 'The instance name of the add-on.', 'type' => 'string', 'title' => '', 'example' => 'mysql1'], + 'AddonVersion' => ['description' => 'The version of the add-on.', 'type' => 'string', 'title' => '', 'example' => '1.1.0'], + 'ScrapeConfigs' => [ + 'description' => 'The capture configurations.', + 'type' => 'array', + 'items' => [ + 'description' => 'scrape config', + 'type' => 'object', + 'properties' => [ + 'JobName' => ['description' => 'The name of the job.', 'type' => 'string', 'example' => 'custom-sd-demo', 'title' => ''], + 'ScrapeInterval' => ['description' => 'The capture interval.', 'type' => 'string', 'title' => '', 'example' => '30s'], + 'MetricsPath' => ['description' => 'The path of the metric.', 'type' => 'string', 'title' => '', 'example' => '/metrics'], + 'ScrapeDiscoverys' => [ + 'title' => '', + 'description' => 'The service discovery methods.', + 'type' => 'array', + 'items' => ['description' => 'The service discovery method.', 'type' => 'string', 'example' => 'static_configs', 'title' => ''], + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', - ], - 'Message' => [ - 'description' => 'The error message that is returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListEnvCustomJobs', + 'extraInfo' => 'ConfigYaml示例：'."\n" + .'```'."\n" + .'scrape_configs:'."\n" + .'- job_name: job-demo1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .'- job_name: job-demo2'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .' http_sd_configs:'."\n" + .' - url: 127.0.0.1:9090'."\n" + .' refresh_interval: 30s'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvCustomJobs'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"FailedInstances\\": [\\n {\\n \\"SourceName\\": \\"sourcename-test\\",\\n \\"SourceType\\": \\"AlibabaPrometheus\\",\\n \\"UserId\\": \\"23784673825*******\\",\\n \\"ClusterId\\": \\"cdb65ed2d527345*********\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', - 'title' => 'UpdatePrometheusGlobalView', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"EnvironmentId\\": \\"env-xxxx\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"CustomJobName\\": \\"job1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\",\\n \\"CreationTimestamp\\": \\"2022-01-01T10:11:34Z\\",\\n \\"AddonName\\": \\"mysql\\",\\n \\"AddonReleaseName\\": \\"mysql1\\",\\n \\"AddonVersion\\": \\"1.1.0\\",\\n \\"ScrapeConfigs\\": [\\n {\\n \\"JobName\\": \\"custom-sd-demo\\",\\n \\"ScrapeInterval\\": \\"30s\\",\\n \\"MetricsPath\\": \\"/metrics\\",\\n \\"ScrapeDiscoverys\\": [\\n \\"static_configs\\"\\n ]\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ListEnvironmentKubeResources' => [ - 'summary' => 'Queries the Kubernetes resources of an environment.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEnvPodMonitors' => [ + 'summary' => 'Queries the PodMonitors of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25107,214 +20039,116 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '195018', - 'abilityTreeNodes' => [ - 'FEATUREarmsC7S24K', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Kind', - 'in' => 'query', - 'schema' => [ - 'title' => '资源kind Pod | Deployment | Service ...等', - 'description' => 'The resource type. Valid values: Pod, Deployment, and Service.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Pod', - ], - ], - [ - 'name' => 'Namespace', - 'in' => 'query', - 'schema' => [ - 'title' => '命名空间', - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'default', - ], - ], - [ - 'name' => 'LabelSelectors', + 'name' => 'EnvironmentId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'title' => '标签选择', - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"app":"mysql"}', - 'description' => 'The tags.'."\n", - ], - ], + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\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', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The result of the operation.', 'type' => 'array', 'items' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'ApiVersion' => [ - 'description' => 'The version number of the API.'."\n", - 'type' => 'string', - 'example' => 'v1', - ], - 'Kind' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'example' => 'Pod', - ], - 'Metadata' => [ - 'description' => 'The metadata.'."\n", - 'type' => 'object', - 'properties' => [ - 'Annotations' => [ - 'description' => 'The annotations.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => ' {'."\n" - .' "kubernetes.io/psp": "ack.privileged",'."\n" - .' "k8s.aliyun.com/pod-ips": "172.16.0.188"'."\n" - .' }', - 'description' => 'The annotations.'."\n", - ], - ], - 'Labels' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The tags.'."\n", - 'example' => '{'."\n" - .' "app": "arms-prometheus-ack-arms-prometheus",'."\n" - .' "releaseRevision": "1",'."\n" - .' "release": "arms-prometheus",'."\n" - .' "pod-template-hash": "c577b6cc8",'."\n" - .' "heritage": "Helm",'."\n" - .' "chart": "ack-arms-prometheus-1.1.17"'."\n" - .' }', - ], - ], - 'Name' => [ - 'description' => 'The resource name.'."\n", - 'type' => 'string', - 'example' => 'arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd', - ], - 'Namespace' => [ - 'description' => 'The namespace.'."\n", - 'type' => 'string', - 'example' => 'arms-prom', + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'EnvironmentId' => ['description' => 'The environment ID.', 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'PodMonitorName' => ['description' => 'The name of the PodMonitor.', 'type' => 'string', 'example' => 'pm1', 'title' => ''], + 'ConfigYaml' => ['description' => 'The YAML configuration string.', 'type' => 'string', 'example' => '参见补充说明。', 'title' => ''], + 'Status' => ['description' => 'The status of the PodMonitor.', 'type' => 'string', 'example' => 'run', 'title' => ''], + 'CreationTimestamp' => ['description' => 'The time when the PodMonitor was created. The value of this parameter is a timestamp.', 'type' => 'string', 'example' => '2011-01-02T11:34:22Z', 'title' => ''], + 'AddonName' => ['description' => 'The name of the add-on to which the PodMonitor belongs.', 'type' => 'string', 'title' => '', 'example' => 'mysql'], + 'AddonReleaseName' => ['description' => 'The instance name of the add-on.', 'type' => 'string', 'title' => '', 'example' => 'mysql1'], + 'AddonVersion' => ['description' => 'The version of the add-on.', 'type' => 'string', 'title' => '', 'example' => '1.0.5'], + 'Endpoints' => [ + 'title' => '', + 'description' => 'The endpoints of the PodMonitor.', + 'type' => 'array', + 'items' => [ + 'description' => 'Endpoint list.', + 'type' => 'object', + 'properties' => [ + 'Port' => ['description' => 'The external port.', 'type' => 'string', 'example' => '9182', 'title' => ''], + 'TargetPort' => ['description' => 'The destination port.', 'type' => 'integer', 'format' => 'int32', 'example' => '3306', 'title' => ''], + 'Path' => ['description' => 'The collection path.', 'type' => 'string', 'example' => '/metrics', 'title' => ''], + 'Interval' => ['description' => 'The collection interval.', 'type' => 'string', 'example' => '30s', 'title' => ''], + 'MatchedTargetCount' => ['description' => 'The number of pods that match the PodMonitor endpoint.', 'type' => 'integer', 'format' => 'int32', 'title' => '', 'example' => '1'], ], + 'title' => '', + 'example' => '', ], - ], - 'Spec' => [ - 'description' => 'The resource specifications.'."\n", - 'type' => 'any', - 'example' => '{'."\n" - .' "dnsPolicy": "ClusterFirst",'."\n" - .' "nodeName": "cn-hangzhou.172.16.0.60",'."\n" - .' "terminationGracePeriodSeconds": 30,'."\n" - .' "enableServiceLinks": true,'."\n" - .' "serviceAccountName": "arms-prom-operator",'."\n" - .' "volumes": ['."\n" - .' {'."\n" - .' "name": "certs",'."\n" - .' "secret": {'."\n" - .' "secretName": "arms-prometheus-ack-arms-prometheus-cert",'."\n" - .' "defaultMode": 420'."\n" - .' }'."\n" - .' }'."\n", - ], - 'Status' => [ - 'description' => 'The status of the resource.'."\n", - 'type' => 'any', - 'example' => 'run', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListEnvPodMonitors', + 'extraInfo' => 'ConfigYaml示例：'."\n" + .'```'."\n" + .'apiVersion: monitoring.coreos.com/v1'."\n" + .'kind: PodMonitor'."\n" + .'metadata:'."\n" + .' name: arms-admin-pm1'."\n" + .' namespace: arms-prom'."\n" + .' annotations:'."\n" + .' arms.prometheus.io/discovery: \'true\''."\n" + .'spec:'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + .' release: arms-prometheus'."\n" + .' namespaceSelector:'."\n" + .' any: true '."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: 30s'."\n" + .' targetPort: 9335'."\n" + .' path: /metrics'."\n" + .' - interval: 10s'."\n" + .' targetPort: 9335'."\n" + .' path: /metrics1'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvPodMonitors'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"message\\",\\n \\"Data\\": [\\n {\\n \\"ApiVersion\\": \\"v1\\",\\n \\"Kind\\": \\"Pod\\",\\n \\"Metadata\\": {\\n \\"Annotations\\": {\\n \\"key\\": \\" {\\\\n \\\\\\"kubernetes.io/psp\\\\\\": \\\\\\"ack.privileged\\\\\\",\\\\n \\\\\\"k8s.aliyun.com/pod-ips\\\\\\": \\\\\\"172.16.0.188\\\\\\"\\\\n }\\"\\n },\\n \\"Labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"app\\\\\\": \\\\\\"arms-prometheus-ack-arms-prometheus\\\\\\",\\\\n \\\\\\"releaseRevision\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"release\\\\\\": \\\\\\"arms-prometheus\\\\\\",\\\\n \\\\\\"pod-template-hash\\\\\\": \\\\\\"c577b6cc8\\\\\\",\\\\n \\\\\\"heritage\\\\\\": \\\\\\"Helm\\\\\\",\\\\n \\\\\\"chart\\\\\\": \\\\\\"ack-arms-prometheus-1.1.17\\\\\\"\\\\n }\\"\\n },\\n \\"Name\\": \\"arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd\\",\\n \\"Namespace\\": \\"arms-prom\\"\\n },\\n \\"Spec\\": \\"{\\\\n \\\\\\"dnsPolicy\\\\\\": \\\\\\"ClusterFirst\\\\\\",\\\\n \\\\\\"nodeName\\\\\\": \\\\\\"cn-hangzhou.172.16.0.60\\\\\\",\\\\n \\\\\\"terminationGracePeriodSeconds\\\\\\": 30,\\\\n \\\\\\"enableServiceLinks\\\\\\": true,\\\\n \\\\\\"serviceAccountName\\\\\\": \\\\\\"arms-prom-operator\\\\\\",\\\\n \\\\\\"volumes\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"certs\\\\\\",\\\\n \\\\\\"secret\\\\\\": {\\\\n \\\\\\"secretName\\\\\\": \\\\\\"arms-prometheus-ack-arms-prometheus-cert\\\\\\",\\\\n \\\\\\"defaultMode\\\\\\": 420\\\\n }\\\\n }\\\\n\\",\\n \\"Status\\": \\"run\\"\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'ListEnvironmentKubeResources', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodMonitorName\\": \\"pm1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\",\\n \\"CreationTimestamp\\": \\"2011-01-02T11:34:22Z\\",\\n \\"AddonName\\": \\"mysql\\",\\n \\"AddonReleaseName\\": \\"mysql1\\",\\n \\"AddonVersion\\": \\"1.0.5\\",\\n \\"Endpoints\\": [\\n {\\n \\"Port\\": \\"9182\\",\\n \\"TargetPort\\": 3306,\\n \\"Path\\": \\"/metrics\\",\\n \\"Interval\\": \\"30s\\",\\n \\"MatchedTargetCount\\": 1\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ListEnvironmentMetricTargets' => [ - 'summary' => 'Queries the targets of an environment.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEnvServiceMonitors' => [ + 'summary' => 'Queries the ServiceMonitors of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25322,268 +20156,115 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '194431', - 'abilityTreeNodes' => [ - 'FEATUREarmsC7S24K', - ], - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'EnvironmentId', - 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], - ], - [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'JobName', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => 'job名称', - 'description' => 'The job name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'blackbox', - ], + 'schema' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - 'Code' => [ - 'description' => 'The status code. 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', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'ActiveTargets' => [ - 'description' => 'The active targets.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The target information.'."\n", - 'type' => 'object', - 'properties' => [ - 'DiscoveredLabels' => [ - 'description' => 'The tags used for service discovery.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "__meta_kubernetes_pod_label_pod_template_hash": "7477c58b8d",'."\n" - .' "__meta_kubernetes_endpoints_name": "mysql-exporter-mysql-1694448841945-service",'."\n" - .' "__meta_kubernetes_endpoint_port_name": "metrics"'."\n" - .'}', - 'description' => 'The tag value.'."\n", - ], - ], - 'GlobalUrl' => [ - 'description' => 'The URL of the target.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', - ], - 'Health' => [ - 'description' => 'The health status.'."\n", - 'type' => 'string', - 'example' => 'up', - ], - 'Labels' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "endpoint": "metrics",'."\n" - .' "instance": "172.16.0.9:9104",'."\n" - .' "pod": "mysql-1694570927659-7655486df8-djg22",'."\n" - .' "service": "mysql-exporter-mysql-1694570927659-service",'."\n" - .' "namespace": "arms-prom",'."\n" - .' "job": "mysql-exporter-mysql-1694570927659-service"'."\n" - .' }', - 'description' => 'The tag value.'."\n", - ], - ], - 'LastError' => [ - 'description' => 'The last error message.'."\n", - 'type' => 'string', - 'example' => 'Get \\"http://172.16.0.86:9104/metrics\\": dial tcp 172.16.0.86:9104: connect: connection refused', - ], - 'LastScrape' => [ - 'description' => 'The last collection time.'."\n", - 'type' => 'string', - 'example' => '2023-10-12T07:15:47.306691514Z', - ], - 'LastScrapeDuration' => [ - 'description' => 'The duration of the last collection.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => ' 0.00127593', - ], - 'LastScrapeSeries' => [ - 'description' => 'The amount of metrics in the last collection.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '122', - ], - 'ScrapePool' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'example' => 'arms-prom/mysql-exporter-mysql-1694429267986-sm/0"', - ], - 'ScrapeUrl' => [ - 'description' => 'The URL of the collection.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', - ], - ], - ], - ], - 'DroppedTargets' => [ - 'description' => 'The deleted targets.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The target information.'."\n", - 'type' => 'object', - 'properties' => [ - 'DiscoveredLabels' => [ - 'description' => 'The tags used for service discovery.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The tag value.'."\n", - 'example' => '{'."\n" - .' "__meta_kubernetes_pod_label_pod_template_hash": "7477c58b8d",'."\n" - .' "__meta_kubernetes_endpoints_name": "mysql-exporter-mysql-1694448841945-service",'."\n" - .' "__meta_kubernetes_endpoint_port_name": "metrics"'."\n" - .'}', - ], - ], - 'GlobalUrl' => [ - 'description' => 'The URL of the target.'."\n", - 'type' => 'string', - 'example' => 'http://xxx', - ], - 'Health' => [ - 'description' => 'The health status.'."\n", - 'type' => 'string', - 'example' => 'up', - ], - 'Labels' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "endpoint": "metrics",'."\n" - .' "instance": "172.16.0.9:9104",'."\n" - .' "pod": "mysql-1694570927659-7655486df8-djg22",'."\n" - .' "service": "mysql-exporter-mysql-1694570927659-service",'."\n" - .' "namespace": "arms-prom",'."\n" - .' "job": "mysql-exporter-mysql-1694570927659-service"'."\n" - .' }', - 'description' => 'The tag value.'."\n", - ], - ], - 'LastError' => [ - 'description' => 'The last error message.'."\n", - 'type' => 'string', - 'example' => 'Get \\"http://172.16.0.86:9104/metrics\\": dial tcp 172.16.0.86:9104: connect: connection refused', - ], - 'LastScrape' => [ - 'description' => 'The last collection time.'."\n", - 'type' => 'string', - 'example' => '2023-10-12T07:15:47.306691514Z', - ], - 'LastScrapeDuration' => [ - 'description' => 'The duration of the last collection.'."\n", - 'type' => 'number', - 'format' => 'double', - 'example' => ' 0.00127593', - ], - 'LastScrapeSeries' => [ - 'description' => 'The amount of metrics in the last collection.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '122', - ], - 'ScrapePool' => [ - 'description' => 'The name of the collection.'."\n", - 'type' => 'string', - 'example' => 'arms-prom/mysql-exporter-mysql-1694429267986-sm/0"', - ], - 'ScrapeUrl' => [ - 'description' => 'The URL of the collection.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', + 'description' => 'The returned struct.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + 'EnvironmentId' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'ServiceMonitorName' => ['description' => 'The name of the ServiceMonitor.'."\n", 'type' => 'string', 'example' => 'sm1', 'title' => ''], + 'ConfigYaml' => ['description' => 'The YAML configuration string.'."\n", 'type' => 'string', 'example' => '参见补充说明。', 'title' => ''], + 'Status' => ['description' => 'The status of the ServiceMonitor.'."\n", 'type' => 'string', 'example' => 'run', 'title' => ''], + 'CreationTimestamp' => ['description' => 'The time when the ServiceMonitor was created. The value of this parameter is a timestamp.'."\n", 'type' => 'string', 'example' => '2011-10-11T22:32:11Z', 'title' => ''], + 'AddonName' => ['title' => '', 'description' => 'The name of the add-on to which the ServiceMonitor belongs.'."\n", 'type' => 'string', 'example' => 'mysql'], + 'AddonReleaseName' => ['title' => '', 'description' => 'The instance name of the add-on.'."\n", 'type' => 'string', 'example' => 'mysql1'], + 'AddonVersion' => ['title' => '', 'description' => 'The version of the add-on.'."\n", 'type' => 'string', 'example' => '1.1.0'], + 'MatchedServiceCount' => ['title' => '', 'description' => 'The number of matched services.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], + 'Endpoints' => [ + 'title' => '', + 'description' => 'The endpoints of the ServiceMonitor.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'List of endpoints for serviceMonitor.', + 'type' => 'object', + 'properties' => [ + 'Port' => ['description' => 'The external port.'."\n", 'type' => 'string', 'example' => '9101', 'title' => ''], + 'TargetPort' => ['description' => 'The destination port.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '443', 'title' => ''], + 'Path' => ['description' => 'The collection path.'."\n", 'type' => 'string', 'example' => '/metrics', 'title' => ''], + 'Interval' => ['description' => 'The collection interval.'."\n", 'type' => 'string', 'example' => '30s', 'title' => ''], + 'MatchedTargetCount' => ['title' => '', 'description' => 'The number of pods that match the ServiceMonitor endpoint.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListEnvServiceMonitors', + 'extraInfo' => 'ConfigYaml示例：'."\n" + .'```'."\n" + .'apiVersion: monitoring.coreos.com/v1'."\n" + .'kind: ServiceMonitor'."\n" + .'metadata:'."\n" + .' name: arms-admin1'."\n" + .' namespace: arms-prom'."\n" + .' annotations:'."\n" + .' arms.prometheus.io/discovery: \'true\''."\n" + .'spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' port: operator'."\n" + .' path: /metrics'."\n" + .' - interval: 10s'."\n" + .' port: operator1'."\n" + .' path: /metrics'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvServiceMonitors'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ActiveTargets\\": [\\n {\\n \\"DiscoveredLabels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"__meta_kubernetes_pod_label_pod_template_hash\\\\\\": \\\\\\"7477c58b8d\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoints_name\\\\\\": \\\\\\"mysql-exporter-mysql-1694448841945-service\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoint_port_name\\\\\\": \\\\\\"metrics\\\\\\"\\\\n}\\"\\n },\\n \\"GlobalUrl\\": \\"http://xxx\\",\\n \\"Health\\": \\"up\\",\\n \\"Labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"endpoint\\\\\\": \\\\\\"metrics\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"172.16.0.9:9104\\\\\\",\\\\n \\\\\\"pod\\\\\\": \\\\\\"mysql-1694570927659-7655486df8-djg22\\\\\\",\\\\n \\\\\\"service\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\",\\\\n \\\\\\"namespace\\\\\\": \\\\\\"arms-prom\\\\\\",\\\\n \\\\\\"job\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\"\\\\n }\\"\\n },\\n \\"LastError\\": \\"Get \\\\\\\\\\\\\\"http://172.16.0.86:9104/metrics\\\\\\\\\\\\\\": dial tcp 172.16.0.86:9104: connect: connection refused\\",\\n \\"LastScrape\\": \\"2023-10-12T07:15:47.306691514Z\\",\\n \\"LastScrapeDuration\\": 0.00127593,\\n \\"LastScrapeSeries\\": 122,\\n \\"ScrapePool\\": \\"arms-prom/mysql-exporter-mysql-1694429267986-sm/0\\\\\\"\\",\\n \\"ScrapeUrl\\": \\"http://xxxx\\"\\n }\\n ],\\n \\"DroppedTargets\\": [\\n {\\n \\"DiscoveredLabels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"__meta_kubernetes_pod_label_pod_template_hash\\\\\\": \\\\\\"7477c58b8d\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoints_name\\\\\\": \\\\\\"mysql-exporter-mysql-1694448841945-service\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoint_port_name\\\\\\": \\\\\\"metrics\\\\\\"\\\\n}\\"\\n },\\n \\"GlobalUrl\\": \\"http://xxx\\",\\n \\"Health\\": \\"up\\",\\n \\"Labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"endpoint\\\\\\": \\\\\\"metrics\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"172.16.0.9:9104\\\\\\",\\\\n \\\\\\"pod\\\\\\": \\\\\\"mysql-1694570927659-7655486df8-djg22\\\\\\",\\\\n \\\\\\"service\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\",\\\\n \\\\\\"namespace\\\\\\": \\\\\\"arms-prom\\\\\\",\\\\n \\\\\\"job\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\"\\\\n }\\"\\n },\\n \\"LastError\\": \\"Get \\\\\\\\\\\\\\"http://172.16.0.86:9104/metrics\\\\\\\\\\\\\\": dial tcp 172.16.0.86:9104: connect: connection refused\\",\\n \\"LastScrape\\": \\"2023-10-12T07:15:47.306691514Z\\",\\n \\"LastScrapeDuration\\": 0.00127593,\\n \\"LastScrapeSeries\\": 122,\\n \\"ScrapePool\\": \\"arms-prom/mysql-exporter-mysql-1694429267986-sm/0\\\\\\"\\",\\n \\"ScrapeUrl\\": \\"http://xxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListEnvironmentMetricTargets', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"RegionId\\": \\"cn-beijing\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"ServiceMonitorName\\": \\"sm1\\",\\n \\"ConfigYaml\\": \\"参见补充说明。\\",\\n \\"Status\\": \\"run\\",\\n \\"CreationTimestamp\\": \\"2011-10-11T22:32:11Z\\",\\n \\"AddonName\\": \\"mysql\\",\\n \\"AddonReleaseName\\": \\"mysql1\\",\\n \\"AddonVersion\\": \\"1.1.0\\",\\n \\"MatchedServiceCount\\": 1,\\n \\"Endpoints\\": [\\n {\\n \\"Port\\": \\"9101\\",\\n \\"TargetPort\\": 443,\\n \\"Path\\": \\"/metrics\\",\\n \\"Interval\\": \\"30s\\",\\n \\"MatchedTargetCount\\": 1\\n }\\n ]\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], 'ListEnvironmentAddons' => [ - 'summary' => 'Queries the information about the add-ons that are installed in an environment.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25591,336 +20272,219 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-xxx'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'response'."\n", + 'description' => 'The response object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '32940175-181B-4B93-966E-4BB69176****', - ], - 'Code' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => '', - 'type' => 'string', - 'example' => 'message', - ], - 'Success' => [ - 'description' => '', - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '32940175-181B-4B93-966E-4BB69176****'], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the operation was successful. Valid values are `true` if the operation succeeded and `false` if it failed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The result of the operation.'."\n", + 'description' => 'The returned data.', 'type' => 'object', 'properties' => [ 'Addons' => [ - 'description' => 'The queried add-ons.'."\n", + 'description' => 'The list of addons.', 'type' => 'array', 'items' => [ - 'description' => 'The details of the add-on.'."\n", + 'description' => 'The addon details.', 'type' => 'object', 'properties' => [ - 'Alias' => [ - 'description' => 'The alias of the add-on.'."\n", - 'type' => 'string', - 'example' => 'MySQL', - ], + 'Alias' => ['description' => 'The alias of the addon.', 'type' => 'string', 'example' => 'MySQL', 'title' => ''], 'Categories' => [ - 'description' => 'The tags of the add-on.'."\n", + 'description' => 'The list of addon tags.', 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => 'cloud', - ], + 'items' => ['description' => 'A tag for the addon.', 'type' => 'string', 'example' => 'cloud', 'title' => ''], + 'title' => '', + 'example' => '', ], 'Dashboards' => [ - 'description' => 'The dashboards.'."\n", + 'description' => 'The list of dashboards.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The dashboard details.', 'type' => 'object', 'properties' => [ - 'Description' => [ - 'description' => 'The description of the dashboard.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Name' => [ - 'description' => 'The name of the dashboard.'."\n", - 'type' => 'string', - 'example' => 'mysql-overview', - ], - 'Url' => [ - 'description' => 'The URL of the dashboard.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', - ], + 'Description' => ['description' => 'The description of the dashboard.', 'type' => 'string', 'example' => 'MySQL监控大盘信息,监控了连接信息,使用信息等指标', 'title' => ''], + 'Name' => ['description' => 'The name of the dashboard.', 'type' => 'string', 'example' => 'mysql-overview', 'title' => ''], + 'Url' => ['description' => 'The URL of the dashboard.', 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - ], - 'Description' => [ - 'description' => 'The description of the add-on.'."\n", - 'type' => 'string', + 'title' => '', 'example' => '', ], + 'Description' => ['description' => 'The description of the addon.', 'type' => 'string', 'example' => '通过 MySQL Exporter 监控数据库指标', 'title' => ''], 'Environments' => [ - 'description' => 'The supported environments.'."\n", + 'description' => 'The list of supported environments.', 'type' => 'array', 'items' => [ - 'description' => 'The information about the environment.'."\n", + 'description' => 'The environment details.', 'type' => 'object', 'properties' => [ 'Dependencies' => [ - 'description' => 'The dependencies of the environment.'."\n", + 'description' => 'The dependencies of the addon within the environment.', 'type' => 'object', 'properties' => [ 'Features' => [ - 'description' => 'The feature that can be installed in the environment.'."\n", + 'description' => 'The features available for installation in the environment.', 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'boolean', - 'description' => 'Indicates whether the feature is supported.'."\n", - 'example' => 'true', - ], + 'additionalProperties' => ['description' => 'Indicates whether the feature is supported.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'title' => '', + 'example' => '', ], 'Services' => [ - 'description' => 'The services.'."\n", + 'description' => 'The dependent services.', 'type' => 'array', - 'items' => [ - 'description' => 'The service name.'."\n", - 'type' => 'string', - 'example' => 'ResourceCenter', - ], + 'items' => ['description' => 'The name of the service.', 'type' => 'string', 'example' => 'ResourceCenter', 'title' => ''], + 'title' => '', + 'example' => '', ], 'ClusterTypes' => [ - 'description' => 'The cluster type.'."\n", + 'description' => 'The required cluster types.', 'type' => 'array', - 'items' => [ - 'description' => 'The cluster type.'."\n", - 'type' => 'string', - 'example' => 'Edge', - ], + 'items' => ['description' => 'The cluster type.', 'type' => 'string', 'example' => 'Edge', 'title' => ''], + 'title' => '', + 'example' => '', ], ], - ], - 'Description' => [ - 'description' => 'The description of the environment.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'Enable' => [ - 'description' => 'Indicates whether the feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Label' => [ - 'description' => 'The tag of the environment.'."\n", - 'type' => 'string', + 'title' => '', 'example' => '', ], - 'Name' => [ - 'description' => 'The name of the environment.'."\n", - 'type' => 'string', - 'example' => 'CS', - ], + 'Description' => ['description' => 'The description of the environment.', 'type' => 'string', 'example' => 'MySQL 服务部署在 Kubernetes 集群中。', 'title' => ''], + 'Enable' => ['description' => 'Indicates whether the addon is supported in this environment.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Label' => ['description' => 'The label of the environment.', 'type' => 'string', 'example' => '容器环境', 'title' => ''], + 'Name' => ['description' => 'The name of the environment.', 'type' => 'string', 'example' => 'CS', 'title' => ''], 'Policies' => [ - 'description' => 'The control policies in the environment.'."\n", + 'description' => 'The policies related to the addon in this environment.', 'type' => 'object', 'properties' => [ - 'AlertDefaultStatus' => [ - 'description' => 'The default alert status.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'DefaultInstall' => [ - 'description' => 'The default installation status.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'TargetAddonName' => [ - 'description' => 'The target name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'cloud-rds-mysql', - ], + 'AlertDefaultStatus' => ['description' => 'The default status of the alert.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'DefaultInstall' => ['description' => 'Indicates whether the addon is installed by default in the environment.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TargetAddonName' => ['description' => 'The target name of the addon.', 'type' => 'string', 'example' => 'cloud-rds-mysql', 'title' => ''], 'Protocols' => [ - 'description' => 'The supported protocols.'."\n", + 'description' => 'The list of supported protocols.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'A supported protocol.', 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the protocol.'."\n", - 'type' => 'string', - 'example' => 'arms', - ], - 'Icon' => [ - 'description' => 'The URL of the protocol icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxxxxxx', - ], - 'Label' => [ - 'description' => 'The tag of the protocol.'."\n", - 'type' => 'string', - 'example' => 'ARMS', - ], - 'Description' => [ - 'description' => 'The description of the protocol.'."\n", - 'type' => 'string', - 'example' => 'ARMS', - ], + 'Name' => ['description' => 'The name of the protocol.', 'type' => 'string', 'example' => 'arms', 'title' => ''], + 'Icon' => ['description' => 'The URL of the protocol icon.', 'type' => 'string', 'example' => 'http://xxxxxxx', 'title' => ''], + 'Label' => ['description' => 'The label of the protocol.', 'type' => 'string', 'example' => 'ARMS', 'title' => ''], + 'Description' => ['description' => 'The description of the protocol.', 'type' => 'string', 'example' => 'ARMS', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'MetricCheckRule' => [ - 'description' => 'The metric check rule.'."\n", + 'description' => 'The rules for checking metric status.', 'type' => 'object', 'properties' => [ 'PromQL' => [ - 'description' => 'The PromQL statements.'."\n", + 'description' => 'The PromQL query statements.', 'type' => 'array', - 'items' => [ - 'description' => 'The PromQL statements.'."\n", - 'type' => 'string', - 'example' => 'max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId=\'983d8f2d-14a9-4af0-a23d-751a7818c239\'}/1000) >= 600.0', - ], + 'items' => ['description' => 'The PromQL query statement.', 'type' => 'string', 'example' => 'max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId=\'983d8f2d-14a9-4af0-a23d-751a7818c239\'}/1000) >= 600.0', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'NeedRestartAfterIntegration' => [ - 'description' => 'Indicates whether a restart is required after the installation.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'EnableServiceAccount' => [ - 'description' => 'Indicates whether a service account is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'NeedRestartAfterIntegration' => ['description' => 'Indicates whether a restart is required after the addon is installed.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'EnableServiceAccount' => ['description' => 'Indicates whether a service account is enabled for the addon.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Icon' => [ - 'description' => 'The URL of the icon.'."\n", - 'type' => 'string', - 'example' => 'http://xxxx', - ], + 'Icon' => ['description' => 'The URL of the addon icon.', 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], 'Keywords' => [ - 'description' => 'The collection of keywords.'."\n", + 'description' => 'The keywords for the addon.', 'type' => 'array', - 'items' => [ - 'description' => 'The keyword.'."\n", - 'type' => 'string', - 'example' => 'Java', - ], - ], - 'Language' => [ - 'description' => 'The language.'."\n", - 'type' => 'string', - 'example' => 'zh', - ], - 'Name' => [ - 'description' => 'The name of the add-on.'."\n", - 'type' => 'string', - 'example' => 'mysql', - ], - 'Once' => [ - 'description' => 'Indicates whether the add-on can be installed only once.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Scene' => [ - 'description' => 'The scenario.'."\n", - 'type' => 'string', - 'example' => 'database', - ], - 'Version' => [ - 'description' => 'The version of the agent.'."\n", - 'type' => 'string', - 'example' => '0.0.1', - ], - 'Weight' => [ - 'description' => 'The weight.'."\n", - 'type' => 'string', - 'example' => '857', - ], - 'LatestReleaseCreateTime' => [ - 'description' => 'The time when the instance was last created.'."\n", - 'type' => 'string', - 'example' => '2023-09-22T16:56:29+08:00', + 'items' => ['description' => 'A keyword for the addon.', 'type' => 'string', 'example' => 'Java', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'Language' => ['description' => 'The language of the addon metadata.', 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'Name' => ['description' => 'The name of the addon.', 'type' => 'string', 'example' => 'mysql', 'title' => ''], + 'Once' => ['description' => 'Indicates whether the addon can be installed only once per environment.', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Scene' => ['description' => 'The application scenario of the addon.', 'type' => 'string', 'example' => 'database', 'title' => ''], + 'Version' => ['description' => 'The addon version.', 'type' => 'string', 'example' => '0.0.1', 'title' => ''], + 'Weight' => ['description' => 'The weight of the addon, which is used for sorting in the UI.', 'type' => 'string', 'example' => '857', 'title' => ''], + 'LatestReleaseCreateTime' => ['description' => 'The creation time of the latest release of the addon.', 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => '', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'ContainsV2Addon' => ['description' => 'Indicates whether the list contains V2 addons.', 'type' => 'boolean', 'title' => '', 'example' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Query the Addon installed in a specified environment', + 'summary' => 'Lists the add-ons installed in a specified environment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentAddons', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32940175-181B-4B93-966E-4BB69176****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Addons\\": [\\n {\\n \\"Alias\\": \\"MySQL\\",\\n \\"Categories\\": [\\n \\"cloud\\"\\n ],\\n \\"Dashboards\\": [\\n {\\n \\"Description\\": \\"MySQL监控大盘信息,监控了连接信息,使用信息等指标\\",\\n \\"Name\\": \\"mysql-overview\\",\\n \\"Url\\": \\"http://xxxx\\"\\n }\\n ],\\n \\"Description\\": \\"通过 MySQL Exporter 监控数据库指标\\",\\n \\"Environments\\": [\\n {\\n \\"Dependencies\\": {\\n \\"Features\\": {\\n \\"key\\": true\\n },\\n \\"Services\\": [\\n \\"ResourceCenter\\"\\n ],\\n \\"ClusterTypes\\": [\\n \\"Edge\\"\\n ]\\n },\\n \\"Description\\": \\"MySQL 服务部署在 Kubernetes 集群中。\\",\\n \\"Enable\\": true,\\n \\"Label\\": \\"容器环境\\",\\n \\"Name\\": \\"CS\\",\\n \\"Policies\\": {\\n \\"AlertDefaultStatus\\": \\"default\\",\\n \\"DefaultInstall\\": false,\\n \\"TargetAddonName\\": \\"cloud-rds-mysql\\",\\n \\"Protocols\\": [\\n {\\n \\"Name\\": \\"arms\\",\\n \\"Icon\\": \\"http://xxxxxxx\\",\\n \\"Label\\": \\"ARMS\\",\\n \\"Description\\": \\"ARMS\\"\\n }\\n ],\\n \\"MetricCheckRule\\": {\\n \\"PromQL\\": [\\n \\"max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId=\'983d8f2d-14a9-4af0-a23d-751a7818c239\'}/1000) >= 600.0\\"\\n ]\\n },\\n \\"NeedRestartAfterIntegration\\": true,\\n \\"EnableServiceAccount\\": true\\n }\\n }\\n ],\\n \\"Icon\\": \\"http://xxxx\\",\\n \\"Keywords\\": [\\n \\"Java\\"\\n ],\\n \\"Language\\": \\"zh\\",\\n \\"Name\\": \\"mysql\\",\\n \\"Once\\": false,\\n \\"Scene\\": \\"database\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"Weight\\": \\"857\\",\\n \\"LatestReleaseCreateTime\\": \\"2023-09-22T16:56:29+08:00\\"\\n }\\n ],\\n \\"Total\\": 1\\n }\\n}","type":"json"}]', - 'title' => 'ListEnvironmentAddons', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"32940175-181B-4B93-966E-4BB69176****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Addons\\": [\\n {\\n \\"Alias\\": \\"MySQL\\",\\n \\"Categories\\": [\\n \\"cloud\\"\\n ],\\n \\"Dashboards\\": [\\n {\\n \\"Description\\": \\"MySQL监控大盘信息,监控了连接信息,使用信息等指标\\",\\n \\"Name\\": \\"mysql-overview\\",\\n \\"Url\\": \\"http://xxxx\\"\\n }\\n ],\\n \\"Description\\": \\"通过 MySQL Exporter 监控数据库指标\\",\\n \\"Environments\\": [\\n {\\n \\"Dependencies\\": {\\n \\"Features\\": {\\n \\"key\\": true\\n },\\n \\"Services\\": [\\n \\"ResourceCenter\\"\\n ],\\n \\"ClusterTypes\\": [\\n \\"Edge\\"\\n ]\\n },\\n \\"Description\\": \\"MySQL 服务部署在 Kubernetes 集群中。\\",\\n \\"Enable\\": true,\\n \\"Label\\": \\"容器环境\\",\\n \\"Name\\": \\"CS\\",\\n \\"Policies\\": {\\n \\"AlertDefaultStatus\\": \\"default\\",\\n \\"DefaultInstall\\": false,\\n \\"TargetAddonName\\": \\"cloud-rds-mysql\\",\\n \\"Protocols\\": [\\n {\\n \\"Name\\": \\"arms\\",\\n \\"Icon\\": \\"http://xxxxxxx\\",\\n \\"Label\\": \\"ARMS\\",\\n \\"Description\\": \\"ARMS\\"\\n }\\n ],\\n \\"MetricCheckRule\\": {\\n \\"PromQL\\": [\\n \\"max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId=\'983d8f2d-14a9-4af0-a23d-751a7818c239\'}/1000) >= 600.0\\"\\n ]\\n },\\n \\"NeedRestartAfterIntegration\\": true,\\n \\"EnableServiceAccount\\": true\\n }\\n }\\n ],\\n \\"Icon\\": \\"http://xxxx\\",\\n \\"Keywords\\": [\\n \\"Java\\"\\n ],\\n \\"Language\\": \\"zh\\",\\n \\"Name\\": \\"mysql\\",\\n \\"Once\\": false,\\n \\"Scene\\": \\"database\\",\\n \\"Version\\": \\"0.0.1\\",\\n \\"Weight\\": \\"857\\",\\n \\"LatestReleaseCreateTime\\": \\"2023-09-22T16:56:29+08:00\\"\\n }\\n ],\\n \\"Total\\": 1,\\n \\"ContainsV2Addon\\": false\\n }\\n}","type":"json"}]', ], 'ListEnvironmentAlertRules' => [ 'summary' => 'Queries the alert groups of an environment instance.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -25928,54 +20492,27 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '环境id', - 'description' => 'The environment ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'env-xxx', - ], + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'AddonName', 'in' => 'query', - 'schema' => [ - 'title' => 'addon的名称,addonName和scene必填一个', - 'description' => 'The name of the add-on. You must specify AddonName or Scene.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mysql', - ], + 'schema' => ['title' => '', 'description' => 'The name of the add-on. You must specify AddonName or Scene.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mysql'], ], [ 'name' => 'Scene', 'in' => 'query', - 'schema' => [ - 'title' => '场景,addonName和scene必填一个', - 'description' => 'The scenario of the add-on. You must specify AddonName or Scene.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'database', - ], + 'schema' => ['title' => '', 'description' => 'The scenario of the add-on. You must specify AddonName or Scene.'."\n", 'type' => 'string', 'required' => false, 'example' => 'database'], ], ], 'responses' => [ @@ -25984,31 +20521,13 @@ 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ 'description' => 'The struct returned.'."\n", 'type' => 'object', @@ -26016,11 +20535,9 @@ 'Groups' => [ 'description' => 'The queried alert groups.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The alert group.'."\n", - 'type' => 'string', - 'example' => 'mysql-CS-MySQLdAlerts', - ], + 'items' => ['description' => 'The alert group.'."\n", 'type' => 'string', 'example' => 'mysql-CS-MySQLdAlerts', 'title' => ''], + 'title' => '', + 'example' => '', ], 'Rules' => [ 'description' => 'The queried rules.'."\n", @@ -26029,48 +20546,39 @@ 'description' => 'The rule.'."\n", 'type' => 'object', 'properties' => [ - 'AlertId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9502571', - ], - 'Name' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'mysql-CS-MySQLInnoDBLogWaits_lu', - ], + 'AlertId' => ['description' => 'The ID of the alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '9502571', 'title' => ''], + 'Name' => ['description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'example' => 'mysql-CS-MySQLInnoDBLogWaits_lu', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '26', - ], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '26', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Groups\\": [\\n \\"mysql-CS-MySQLdAlerts\\"\\n ],\\n \\"Rules\\": [\\n {\\n \\"AlertId\\": 9502571,\\n \\"Name\\": \\"mysql-CS-MySQLInnoDBLogWaits_lu\\"\\n }\\n ],\\n \\"Total\\": 26\\n }\\n}","type":"json"}]', 'title' => 'ListEnvironmentAlertRules', - ], - 'ListGrafanaWorkspace' => [ - 'summary' => 'Obtain Specified Workspace List', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListEnvironmentDashboards' => [ + 'summary' => 'Queries information about a dashboard of an environment instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26078,70 +20586,131 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID of the instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'AddonName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['title' => '', 'description' => 'Name of Addon,One of AddonName and Scene must be filled in.', 'type' => 'string', 'required' => false, 'example' => 'trace-java'], ], [ - 'name' => 'Tags', + 'name' => 'Scene', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'The scenario of Addon. Either AddonName or Scene is required.'."\n", 'type' => 'string', 'required' => false, 'example' => 'database'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', + 'description' => 'response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The result of the operation.'."\n", + 'type' => 'object', + 'properties' => [ + 'Dashboards' => [ + 'description' => 'The dashboards.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'Dashboard details.', + 'type' => 'object', + 'properties' => [ + 'FolderUid' => ['description' => 'The UID of the folder.'."\n", 'type' => 'string', 'example' => '1374923841627893', 'title' => ''], + 'Region' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hongkong', 'title' => ''], + 'Tags' => [ + 'description' => 'The keyword.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tags.'."\n", 'type' => 'string', 'example' => 'k8s', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Title' => ['description' => 'The title of the Grafana dashboard.'."\n", 'type' => 'string', 'example' => 'kafka-instance', 'title' => ''], + 'Uid' => ['description' => 'The unique identifier of the dashboard.'."\n", 'type' => 'string', 'example' => '1537863211936042', 'title' => ''], + 'Url' => ['description' => 'The complete URL of the dashboard.'."\n", 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"message\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Dashboards\\": [\\n {\\n \\"FolderUid\\": \\"1374923841627893\\",\\n \\"Region\\": \\"cn-hongkong\\",\\n \\"Tags\\": [\\n \\"k8s\\"\\n ],\\n \\"Title\\": \\"kafka-instance\\",\\n \\"Uid\\": \\"1537863211936042\\",\\n \\"Url\\": \\"http://xxx\\"\\n }\\n ],\\n \\"Total\\": 1\\n }\\n}","type":"json"}]', + 'title' => 'ListEnvironmentDashboards', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvironmentDashboards'], + ], + ], + 'ramActions' => [], + ], + 'ListEnvironmentFeatures' => [ + 'summary' => 'Queries the features in an environment.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], [ 'name' => 'AliyunLang', 'in' => 'query', 'schema' => [ - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", + 'title' => '', + 'description' => 'The language. Default value: zh.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* en: English.'."\n" + .'* zh: Chinese.'."\n", 'type' => 'string', 'required' => false, + 'enumValueTitles' => ['en' => '', 'zh' => ''], 'example' => 'zh', ], ], @@ -26149,106 +20718,80 @@ 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '0080BE65-167F-5CB6-A691-14E2EFD474BC', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****'], + 'Code' => ['description' => 'Status Code. Description 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" + ."\n" + .'* `true`: The alert rule was deleted.'."\n" + .'* `false`: The alert rule failed to be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], 'Data' => [ - 'description' => 'The returned result.'."\n", + 'description' => 'The returned struct.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The information about the Grafana workspace.'."\n", - '$ref' => '#/components/schemas/GrafanaWorkspace', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'The feature configuration.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The feature configuration.'."\n", 'example' => '{}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Description' => ['description' => 'The description of the feature.'."\n", 'type' => 'string', 'example' => '以 Prometheus 采集规范采集 Metric 数据。', 'title' => ''], + 'EnvironmentId' => ['description' => 'The ID of the environment instance.'."\n", 'type' => 'string', 'example' => 'env-xxxxx', 'title' => ''], + 'Language' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* zh: Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'example' => 'zh', 'title' => ''], + 'LatestVersion' => ['description' => 'The latest version number.'."\n", 'type' => 'string', 'example' => '1.1.17', 'title' => ''], + 'Name' => ['description' => 'The name of the feature.'."\n", 'type' => 'string', 'example' => 'metric-agent', 'title' => ''], + 'Status' => ['description' => 'The status of the feature. Valid values:'."\n" + ."\n" + .'* Installing: The agent is being installed.'."\n" + .'* Success: The agent is installed.'."\n" + .'* Failed: The agent failed to be installed.'."\n" + .'* UnInstall: The agent is uninstalled.'."\n" + .'* Uninstalling: The agent is being uninstalled.'."\n" + .'* UnInstallFailed: The agent failed to be uninstalled.'."\n", 'type' => 'string', 'example' => 'Success', 'title' => ''], + 'Version' => ['description' => 'The version of the feature.'."\n", 'type' => 'string', 'example' => '1.1.17', 'title' => ''], + 'Alias' => ['description' => 'The alias of the feature.'."\n", 'type' => 'string', 'example' => 'Prometheus 探针', 'title' => ''], + 'Icon' => ['description' => 'The URL of the icon.'."\n", 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + 'Managed' => ['description' => 'Indicates whether the component is fully managed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - ], - 'Message' => [ - 'description' => 'The error message returned if the request parameters are invalid.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code. 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: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'TraceId' => [ - 'description' => 'The trace ID that is used to query the details of the request.'."\n", - 'type' => 'string', - 'example' => 'eac0a8048716731735000007137d000b', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ResourceIdIsIllegal', - 'errorMessage' => 'The specified ResourceId is invalid.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'AccountUidAccessError', - 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": [\\n {\\n \\"Config\\": {\\n \\"key\\": \\"{}\\"\\n },\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据。\\",\\n \\"EnvironmentId\\": \\"env-xxxxx\\",\\n \\"Language\\": \\"zh\\",\\n \\"LatestVersion\\": \\"1.1.17\\",\\n \\"Name\\": \\"metric-agent\\",\\n \\"Status\\": \\"Success\\",\\n \\"Version\\": \\"1.1.17\\",\\n \\"Alias\\": \\"Prometheus 探针\\",\\n \\"Icon\\": \\"http://xxx\\",\\n \\"Managed\\": true\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListEnvironmentFeatures', + 'changeSet' => [ + ['createdAt' => '2024-05-23T02:55:42.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-23T08:07:33.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvironmentFeatures'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0080BE65-167F-5CB6-A691-14E2EFD474BC\\",\\n \\"Data\\": [\\n {\\n \\"status\\": \\"Starting/Running/Stop/DeleteSucceed\\",\\n \\"description\\": \\"\\",\\n \\"grafanaWorkspaceEdition\\": \\"experts_edition/advanced_edition/standard\\",\\n \\"endTime\\": 1652803200000,\\n \\"grafanaWorkspaceId\\": \\"g-thisisademo666\\",\\n \\"upgradeVersion\\": [\\n \\"\\"\\n ],\\n \\"grafanaWorkspaceIp\\": \\"127.0.0.1:3000\\",\\n \\"snatIp\\": \\"1.1.1.1\\",\\n \\"grafanaWorkspaceDomain\\": \\"\\",\\n \\"grafanaWorkspaceDomainStatus\\": \\"on\\",\\n \\"commercial\\": true,\\n \\"grafanaWorkspaceName\\": \\"\\",\\n \\"grafanaVersion\\": \\"\\",\\n \\"gmtCreate\\": 0,\\n \\"userId\\": \\"66666666\\",\\n \\"maxAccount\\": \\"10\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"protocol\\": \\"http/https\\",\\n \\"shareSynced\\": true,\\n \\"ntmId\\": \\"\\",\\n \\"personalDomain\\": \\"\\",\\n \\"personalDomainPrefix\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"deployType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"privateIp\\": \\"\\",\\n \\"privateDomain\\": \\"\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\"\\n}","type":"json"}]', - 'title' => 'ListGrafanaWorkspace', - 'description' => '>The list returned by this operation includes the workspaces of Developer Edition, Expert Edition, and Advanced Edition. The list does not include the workspaces of Shared Edition.', + 'ramActions' => [], ], - 'GetGrafanaWorkspace' => [ - 'summary' => 'Queries the information about a Grafana workspace.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEnvironmentKubeResources' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -26257,831 +20800,821 @@ 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', + 'abilityTreeCode' => '195018', + 'abilityTreeNodes' => ['FEATUREarmsC7S24K'], ], 'parameters' => [ [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-xxx'], + ], + [ 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GrafanaWorkspaceId', + 'name' => 'Kind', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'grafana-cn-4xl3g******', - ], + 'schema' => ['description' => 'The resource type. Valid values: Pod, Deployment, and Service.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'Pod'], ], [ - 'name' => 'AliyunLang', + 'name' => 'Namespace', 'in' => 'query', + 'schema' => ['description' => 'The namespace.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'default'], + ], + [ + 'name' => 'LabelSelectors', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', + 'title' => '', + 'description' => 'The tags.', + 'type' => 'object', 'required' => false, - 'example' => 'zh', + 'additionalProperties' => ['description' => 'The tags.', 'type' => 'string', 'example' => '{"app":"mysql"}', 'title' => ''], + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2C3F217B-9AAE-5D51-974D-48********', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], 'Data' => [ - 'description' => 'The information about the Grafana workspace.'."\n", - '$ref' => '#/components/schemas/GrafanaWorkspace', - ], - 'Message' => [ - 'description' => 'The error message returned when the request parameters are invalid.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* `2XX`: The request is successful.'."\n" - .'* `3XX`: A redirection message is returned.'."\n" - .'* `4XX`: The request is invalid.'."\n" - .'* `5XX`: A server error occurs.'."\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', - ], - 'TraceId' => [ - 'description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", - 'type' => 'string', - 'example' => 'eac0a8048716731735000007137d000b', + 'description' => 'The returned struct.', + 'type' => 'array', + 'items' => [ + 'description' => 'The returned struct.', + 'type' => 'object', + 'properties' => [ + 'ApiVersion' => ['description' => 'The version number of the API.', 'type' => 'string', 'example' => 'v1', 'title' => ''], + 'Kind' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'Pod', 'title' => ''], + 'Metadata' => [ + 'description' => 'The metadata.', + 'type' => 'object', + 'properties' => [ + 'Annotations' => [ + 'description' => 'The annotations.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The annotations.', 'type' => 'string', 'example' => ' {'."\n" + .' "kubernetes.io/psp": "ack.privileged",'."\n" + .' "k8s.aliyun.com/pod-ips": "172.16.0.188"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Labels' => [ + 'description' => 'The tags.', + 'type' => 'object', + 'additionalProperties' => ['description' => 'The tags.', 'type' => 'string', 'example' => '{'."\n" + .' "app": "arms-prometheus-ack-arms-prometheus",'."\n" + .' "releaseRevision": "1",'."\n" + .' "release": "arms-prometheus",'."\n" + .' "pod-template-hash": "c577b6cc8",'."\n" + .' "heritage": "Helm",'."\n" + .' "chart": "ack-arms-prometheus-1.1.17"'."\n" + .' }', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Name' => ['description' => 'The resource name.', 'type' => 'string', 'example' => 'arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'Spec' => ['description' => 'The resource specifications.', 'type' => 'any', 'example' => '{'."\n" + .' "dnsPolicy": "ClusterFirst",'."\n" + .' "nodeName": "cn-hangzhou.172.16.0.60",'."\n" + .' "terminationGracePeriodSeconds": 30,'."\n" + .' "enableServiceLinks": true,'."\n" + .' "serviceAccountName": "arms-prom-operator",'."\n" + .' "volumes": ['."\n" + .' {'."\n" + .' "name": "certs",'."\n" + .' "secret": {'."\n" + .' "secretName": "arms-prometheus-ack-arms-prometheus-cert",'."\n" + .' "defaultMode": 420'."\n" + .' }'."\n" + .' }'."\n", 'title' => ''], + 'Status' => ['description' => 'The status of the resource.', 'type' => 'any', 'example' => 'run', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ResourceIdIsIllegal', - 'errorMessage' => 'The specified ResourceId is invalid.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'AccountUidAccessError', - 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListEnvironmentKubeResources', + 'summary' => 'Queries the Kubernetes resources of an environment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2C3F217B-9AAE-5D51-974D-48********\\",\\n \\"Data\\": {\\n \\"status\\": \\"Starting/Running/Stop/DeleteSucceed\\",\\n \\"description\\": \\"\\",\\n \\"grafanaWorkspaceEdition\\": \\"experts_edition/advanced_edition/standard\\",\\n \\"endTime\\": 1652803200000,\\n \\"grafanaWorkspaceId\\": \\"g-thisisademo666\\",\\n \\"upgradeVersion\\": [\\n \\"\\"\\n ],\\n \\"grafanaWorkspaceIp\\": \\"127.0.0.1:3000\\",\\n \\"snatIp\\": \\"1.1.1.1\\",\\n \\"grafanaWorkspaceDomain\\": \\"\\",\\n \\"grafanaWorkspaceDomainStatus\\": \\"on\\",\\n \\"commercial\\": true,\\n \\"grafanaWorkspaceName\\": \\"\\",\\n \\"grafanaVersion\\": \\"\\",\\n \\"gmtCreate\\": 0,\\n \\"userId\\": \\"66666666\\",\\n \\"maxAccount\\": \\"10\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"protocol\\": \\"http/https\\",\\n \\"shareSynced\\": true,\\n \\"ntmId\\": \\"\\",\\n \\"personalDomain\\": \\"\\",\\n \\"personalDomainPrefix\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"deployType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"privateIp\\": \\"\\",\\n \\"privateDomain\\": \\"\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\"\\n}","type":"json"}]', - 'title' => 'GetGrafanaWorkspace', - 'description' => 'Note: The list returned by this operation includes the workspaces of Developer Edition, Expert Edition, and Advanced Edition. The list does not include the workspaces of Shared Edition.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"message\\",\\n \\"Data\\": [\\n {\\n \\"ApiVersion\\": \\"v1\\",\\n \\"Kind\\": \\"Pod\\",\\n \\"Metadata\\": {\\n \\"Annotations\\": {\\n \\"key\\": \\" {\\\\n \\\\\\"kubernetes.io/psp\\\\\\": \\\\\\"ack.privileged\\\\\\",\\\\n \\\\\\"k8s.aliyun.com/pod-ips\\\\\\": \\\\\\"172.16.0.188\\\\\\"\\\\n }\\"\\n },\\n \\"Labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"app\\\\\\": \\\\\\"arms-prometheus-ack-arms-prometheus\\\\\\",\\\\n \\\\\\"releaseRevision\\\\\\": \\\\\\"1\\\\\\",\\\\n \\\\\\"release\\\\\\": \\\\\\"arms-prometheus\\\\\\",\\\\n \\\\\\"pod-template-hash\\\\\\": \\\\\\"c577b6cc8\\\\\\",\\\\n \\\\\\"heritage\\\\\\": \\\\\\"Helm\\\\\\",\\\\n \\\\\\"chart\\\\\\": \\\\\\"ack-arms-prometheus-1.1.17\\\\\\"\\\\n }\\"\\n },\\n \\"Name\\": \\"arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd\\",\\n \\"Namespace\\": \\"arms-prom\\"\\n },\\n \\"Spec\\": \\"{\\\\n \\\\\\"dnsPolicy\\\\\\": \\\\\\"ClusterFirst\\\\\\",\\\\n \\\\\\"nodeName\\\\\\": \\\\\\"cn-hangzhou.172.16.0.60\\\\\\",\\\\n \\\\\\"terminationGracePeriodSeconds\\\\\\": 30,\\\\n \\\\\\"enableServiceLinks\\\\\\": true,\\\\n \\\\\\"serviceAccountName\\\\\\": \\\\\\"arms-prom-operator\\\\\\",\\\\n \\\\\\"volumes\\\\\\": [\\\\n {\\\\n \\\\\\"name\\\\\\": \\\\\\"certs\\\\\\",\\\\n \\\\\\"secret\\\\\\": {\\\\n \\\\\\"secretName\\\\\\": \\\\\\"arms-prometheus-ack-arms-prometheus-cert\\\\\\",\\\\n \\\\\\"defaultMode\\\\\\": 420\\\\n }\\\\n }\\\\n\\",\\n \\"Status\\": \\"run\\"\\n }\\n ]\\n}","type":"json"}]', ], - 'CreateGrafanaWorkspace' => [ - 'summary' => 'Creates a workspace in Managed Service for Grafana.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEnvironmentMetricTargets' => [ + 'summary' => 'Queries the targets of an environment.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'create', + 'operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free', - 'abilityTreeCode' => '164616', - 'abilityTreeNodes' => [ - 'FEATUREarmsRY7LT8', - ], - 'autoTest' => false, - 'notSupportAutoTestReason' => '涉及数据库任务，为了客户恢复需求，数据库资源不做释放，自动化调用资源浪费', + 'abilityTreeCode' => '194431', + 'abilityTreeNodes' => ['FEATUREarmsC7S24K'], ], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'EnvironmentId', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], [ - 'name' => 'GrafanaWorkspaceName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the Grafana workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'testgrafana', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GrafanaWorkspaceEdition', + 'name' => 'JobName', 'in' => 'query', - 'schema' => [ - 'description' => 'The edition.'."\n" - ."\n" - .'**Valid values:**'."\n" - ."\n" - .'* standard: `Beta Edition or Standard Edition`'."\n" - .'* personal_edition: Developer Edition'."\n" - .'* experts_edition: Pro Edition'."\n" - .'* advanced_edition: Advanced Edition'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'experts_edition', - ], + 'schema' => ['title' => '', 'description' => 'The job name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'blackbox'], ], - [ - 'name' => 'Description', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The description of the workspace', - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'description' => 'response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'ActiveTargets' => [ + 'description' => 'The active targets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The target information.'."\n", + 'type' => 'object', + 'properties' => [ + 'DiscoveredLabels' => [ + 'description' => 'The tags used for service discovery.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "__meta_kubernetes_pod_label_pod_template_hash": "7477c58b8d",'."\n" + .' "__meta_kubernetes_endpoints_name": "mysql-exporter-mysql-1694448841945-service",'."\n" + .' "__meta_kubernetes_endpoint_port_name": "metrics"'."\n" + .'}', 'description' => 'The tag value.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'GlobalUrl' => ['description' => 'The URL of the target.'."\n", 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + 'Health' => ['description' => 'The health status.'."\n", 'type' => 'string', 'example' => 'up', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "endpoint": "metrics",'."\n" + .' "instance": "172.16.0.9:9104",'."\n" + .' "pod": "mysql-1694570927659-7655486df8-djg22",'."\n" + .' "service": "mysql-exporter-mysql-1694570927659-service",'."\n" + .' "namespace": "arms-prom",'."\n" + .' "job": "mysql-exporter-mysql-1694570927659-service"'."\n" + .' }', 'description' => 'The tag value.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'LastError' => ['description' => 'The last error message.'."\n", 'type' => 'string', 'example' => 'Get \\"http://172.16.0.86:9104/metrics\\": dial tcp 172.16.0.86:9104: connect: connection refused', 'title' => ''], + 'LastScrape' => ['description' => 'The last collection time.'."\n", 'type' => 'string', 'example' => '2023-10-12T07:15:47.306691514Z', 'title' => ''], + 'LastScrapeDuration' => ['description' => 'The duration of the last collection.'."\n", 'type' => 'number', 'format' => 'double', 'example' => ' 0.00127593', 'title' => ''], + 'LastScrapeSeries' => ['description' => 'The amount of metrics in the last collection.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '122', 'title' => ''], + 'ScrapePool' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'example' => 'arms-prom/mysql-exporter-mysql-1694429267986-sm/0"', 'title' => ''], + 'ScrapeUrl' => ['description' => 'The URL of the collection.'."\n", 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'DroppedTargets' => [ + 'description' => 'The deleted targets.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The target information.'."\n", + 'type' => 'object', + 'properties' => [ + 'DiscoveredLabels' => [ + 'description' => 'The tags used for service discovery.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'The tag value.'."\n", 'example' => '{'."\n" + .' "__meta_kubernetes_pod_label_pod_template_hash": "7477c58b8d",'."\n" + .' "__meta_kubernetes_endpoints_name": "mysql-exporter-mysql-1694448841945-service",'."\n" + .' "__meta_kubernetes_endpoint_port_name": "metrics"'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'GlobalUrl' => ['description' => 'The URL of the target.'."\n", 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + 'Health' => ['description' => 'The health status.'."\n", 'type' => 'string', 'example' => 'up', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "endpoint": "metrics",'."\n" + .' "instance": "172.16.0.9:9104",'."\n" + .' "pod": "mysql-1694570927659-7655486df8-djg22",'."\n" + .' "service": "mysql-exporter-mysql-1694570927659-service",'."\n" + .' "namespace": "arms-prom",'."\n" + .' "job": "mysql-exporter-mysql-1694570927659-service"'."\n" + .' }', 'description' => 'The tag value.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'LastError' => ['description' => 'The last error message.'."\n", 'type' => 'string', 'example' => 'Get \\"http://172.16.0.86:9104/metrics\\": dial tcp 172.16.0.86:9104: connect: connection refused', 'title' => ''], + 'LastScrape' => ['description' => 'The last collection time.'."\n", 'type' => 'string', 'example' => '2023-10-12T07:15:47.306691514Z', 'title' => ''], + 'LastScrapeDuration' => ['description' => 'The duration of the last collection.'."\n", 'type' => 'number', 'format' => 'double', 'example' => ' 0.00127593', 'title' => ''], + 'LastScrapeSeries' => ['description' => 'The amount of metrics in the last collection.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '122', 'title' => ''], + 'ScrapePool' => ['description' => 'The name of the collection.'."\n", 'type' => 'string', 'example' => 'arms-prom/mysql-exporter-mysql-1694429267986-sm/0"', 'title' => ''], + 'ScrapeUrl' => ['description' => 'The URL of the collection.'."\n", 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"ActiveTargets\\": [\\n {\\n \\"DiscoveredLabels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"__meta_kubernetes_pod_label_pod_template_hash\\\\\\": \\\\\\"7477c58b8d\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoints_name\\\\\\": \\\\\\"mysql-exporter-mysql-1694448841945-service\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoint_port_name\\\\\\": \\\\\\"metrics\\\\\\"\\\\n}\\"\\n },\\n \\"GlobalUrl\\": \\"http://xxx\\",\\n \\"Health\\": \\"up\\",\\n \\"Labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"endpoint\\\\\\": \\\\\\"metrics\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"172.16.0.9:9104\\\\\\",\\\\n \\\\\\"pod\\\\\\": \\\\\\"mysql-1694570927659-7655486df8-djg22\\\\\\",\\\\n \\\\\\"service\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\",\\\\n \\\\\\"namespace\\\\\\": \\\\\\"arms-prom\\\\\\",\\\\n \\\\\\"job\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\"\\\\n }\\"\\n },\\n \\"LastError\\": \\"Get \\\\\\\\\\\\\\"http://172.16.0.86:9104/metrics\\\\\\\\\\\\\\": dial tcp 172.16.0.86:9104: connect: connection refused\\",\\n \\"LastScrape\\": \\"2023-10-12T07:15:47.306691514Z\\",\\n \\"LastScrapeDuration\\": 0.00127593,\\n \\"LastScrapeSeries\\": 122,\\n \\"ScrapePool\\": \\"arms-prom/mysql-exporter-mysql-1694429267986-sm/0\\\\\\"\\",\\n \\"ScrapeUrl\\": \\"http://xxxx\\"\\n }\\n ],\\n \\"DroppedTargets\\": [\\n {\\n \\"DiscoveredLabels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"__meta_kubernetes_pod_label_pod_template_hash\\\\\\": \\\\\\"7477c58b8d\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoints_name\\\\\\": \\\\\\"mysql-exporter-mysql-1694448841945-service\\\\\\",\\\\n \\\\\\"__meta_kubernetes_endpoint_port_name\\\\\\": \\\\\\"metrics\\\\\\"\\\\n}\\"\\n },\\n \\"GlobalUrl\\": \\"http://xxx\\",\\n \\"Health\\": \\"up\\",\\n \\"Labels\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"endpoint\\\\\\": \\\\\\"metrics\\\\\\",\\\\n \\\\\\"instance\\\\\\": \\\\\\"172.16.0.9:9104\\\\\\",\\\\n \\\\\\"pod\\\\\\": \\\\\\"mysql-1694570927659-7655486df8-djg22\\\\\\",\\\\n \\\\\\"service\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\",\\\\n \\\\\\"namespace\\\\\\": \\\\\\"arms-prom\\\\\\",\\\\n \\\\\\"job\\\\\\": \\\\\\"mysql-exporter-mysql-1694570927659-service\\\\\\"\\\\n }\\"\\n },\\n \\"LastError\\": \\"Get \\\\\\\\\\\\\\"http://172.16.0.86:9104/metrics\\\\\\\\\\\\\\": dial tcp 172.16.0.86:9104: connect: connection refused\\",\\n \\"LastScrape\\": \\"2023-10-12T07:15:47.306691514Z\\",\\n \\"LastScrapeDuration\\": 0.00127593,\\n \\"LastScrapeSeries\\": 122,\\n \\"ScrapePool\\": \\"arms-prom/mysql-exporter-mysql-1694429267986-sm/0\\\\\\"\\",\\n \\"ScrapeUrl\\": \\"http://xxxx\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'ListEnvironmentMetricTargets', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'ListEnvironments' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'GrafanaVersion', - 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => true, - 'example' => '10.0.x', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190992', + 'abilityTreeNodes' => ['FEATUREarmsC7S24K'], + ], + 'parameters' => [ [ - 'name' => 'Password', + 'name' => 'EnvironmentType', 'in' => 'query', 'schema' => [ - 'description' => 'The password of the workspace. The password must be 8 to 30 characters in length. It must include at least three of the following characters types: uppercase letter, lowercase letter, digit, and special character. Special characters include () \' ~ ! @ # $ % ^ & \\* - \\_ + =.'."\n", + 'description' => 'The environment type. You must specify at least one of the AddonName and EnvironmentType parameters.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- CS'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' Container Service for Kubernetes (ACK)'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'- ECS'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' Elastic Compute Service (ECS)'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .'- Cloud'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' :'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' cloud service'."\n" + ."\n" + .' <!-- -->', + 'enumValueTitles' => ['CS' => 'Container service', 'ECS' => 'ECS service', 'Cloud' => 'Cloud service'], 'type' => 'string', 'required' => false, - 'example' => 'Test123456!', - ], - ], - [ - 'name' => 'AutoRenew', - 'in' => 'query', - 'schema' => [ 'title' => '', - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => 'false', + 'example' => 'CS', ], ], [ - 'name' => 'PricingCycle', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => '包年包月的计费周期，取值： Month（默认值）：按月购买。 Year：按年购买。', - 'type' => 'string', - 'required' => false, - 'example' => 'Month', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Duration', + 'name' => 'AddonName', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '6', - ], + 'schema' => ['description' => 'The add-on name. You must specify at least one of the AddonName and EnvironmentType parameters.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'trace-java'], ], [ - 'name' => 'AccountNumber', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => '', - 'type' => 'string', - 'required' => false, - 'example' => '10', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-aekzfurdatohtka', 'title' => ''], ], [ - 'name' => 'CustomAccountNumber', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => '', - 'type' => 'string', + 'description' => 'The tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource tag value.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'env', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'gfn_web_outbound_add', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AliyunLang', + 'name' => 'BindResourceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Default value: zh. Valid values:'."\n" - ."\n" - .'* zh'."\n" - .'* en'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - 'default' => 'zh', - ], + 'schema' => ['description' => 'The ID of the resource.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'cb9229c48e41144dc96af190841808cb0'], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'FeePackage', 'in' => 'query', 'schema' => [ - 'description' => 'The resource group ID.'."\n", + 'description' => 'The payable resource plan.'."\n" + ."\n" + .'- If the EnvironmentType parameter is set to CS, set the value to CS\\_Basic or CS\\_Pro. Default value: CS\\_Basic.'."\n" + ."\n" + .'- Otherwise, leave the parameter empty.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'- CS\\_Pro: Container Monitoring Pro'."\n" + ."\n" + .'- CS\\_Basic: Container Monitoring Basic', + 'enumValueTitles' => ['CS_Pro' => 'Container Monitoring Pro', 'CS_Basic' => 'Container Monitoring Basi'], 'type' => 'string', 'required' => false, - 'example' => 'rg-acfmxyexli2****', + 'example' => 'CS_Pro', + 'title' => '', ], ], [ - 'name' => 'Tags', + 'name' => 'FilterRegionIds', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The region IDs to be queried.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'cn-beijing,cn-hangzhou'], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The response parameters.'."\n", + 'description' => 'response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'title' => '', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. 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' => ''], 'Data' => [ - 'description' => 'The information about the Grafana workspace.'."\n", - '$ref' => '#/components/schemas/GrafanaWorkspace', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\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', - ], - 'TraceId' => [ - 'description' => 'The ID of the trace.'."\n", - 'type' => 'string', - 'example' => 'eac0a8048716731735000007137d000b', + 'description' => 'The returned struct.', + 'type' => 'object', + 'properties' => [ + 'Environments' => [ + 'description' => 'The queried environments.', + 'type' => 'array', + 'items' => [ + 'description' => 'Environment details.', + 'type' => 'object', + 'properties' => [ + 'Addons' => [ + 'description' => 'The add-ons.', + 'type' => 'array', + 'items' => [ + 'description' => 'Addon details.', + 'type' => 'object', + 'properties' => [ + 'Alias' => ['description' => 'The alias of the add-on.', 'type' => 'string', 'example' => 'Prometheus探针', 'title' => ''], + 'Description' => ['description' => 'The description of the add-on.', 'type' => 'string', 'example' => '以 Prometheus 采集规范采集 Metric 数据', 'title' => ''], + 'Icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'http://xxxx', 'title' => ''], + 'Name' => ['description' => 'The name of the add-on.', 'type' => 'string', 'example' => 'metric-agent', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '13990957477389', 'title' => ''], + 'BindResourceId' => ['description' => 'The ID of the resource bound to the environment instance. The resource can be a Kubernetes cluster or a VPC.', 'type' => 'string', 'example' => 'vpc-bp1bgo8ronn', 'title' => ''], + 'BindResourceProfile' => ['description' => 'The profile that is bound to the resource.', 'type' => 'string', 'example' => 'xxx', 'title' => ''], + 'BindResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'VPC', 'title' => ''], + 'BindVpcCidr' => ['description' => 'The CIDR block that is bound to the VPC.', 'type' => 'string', 'example' => '172.16.0.0/12', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the environment instance was created.', 'type' => 'string', 'example' => '2023-03-24 11:58:35 +0800', 'title' => ''], + 'CreatedUserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '12378523784982', 'title' => ''], + 'EnvironmentId' => ['description' => 'The ID of the environment instance.', 'type' => 'string', 'example' => 'env-xxx', 'title' => ''], + 'EnvironmentName' => ['description' => 'The name of the environment instance.', 'type' => 'string', 'example' => 'feiliks-biz-prod-edas', 'title' => ''], + 'EnvironmentType' => [ + 'description' => 'The type of the environment instance. Valid values:'."\n" + ."\n" + .'- CS: Container Service'."\n" + ."\n" + .'- ECS: Elastic Compute Service'."\n" + ."\n" + .'- Cloud: cloud service', + 'enumValueTitles' => ['CS' => 'Container service', 'ECS' => 'ECS service', 'Cloud' => 'Cloud service'], + 'type' => 'string', + 'example' => 'CS', + 'title' => '', + ], + 'Features' => [ + 'description' => 'The parameters of the feature.', + 'type' => 'array', + 'items' => [ + 'description' => 'Feature details.', + 'type' => 'object', + 'properties' => [ + 'Alias' => ['description' => 'The alias of the feature.', 'type' => 'string', 'example' => 'Prometheus 探针', 'title' => ''], + 'Description' => ['description' => 'The description of the feature.', 'type' => 'string', 'example' => '以 Prometheus 采集规范采集 Metric 数据', 'title' => ''], + 'Icon' => ['description' => 'The URL of the icon.', 'type' => 'string', 'example' => 'http://xxx', 'title' => ''], + 'Name' => ['description' => 'The name of the feature.', 'type' => 'string', 'example' => 'metirc-agent', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GrafanaFolderTitle' => ['description' => 'The name of the Grafana directory.', 'type' => 'string', 'example' => 'filepath', 'title' => ''], + 'GrafanaFolderUid' => ['description' => 'The unique ID of the Grafana directory.', 'type' => 'string', 'example' => '1798319482935', 'title' => ''], + 'PrometheusId' => ['description' => 'The Prometheus ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '124769812', 'title' => ''], + 'PrometheusInstanceId' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'example' => 'vpc-m5e4alj2i24ndbn', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-zhangjiakou', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'example' => 'rg-acfmvt3xpr5aema', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags of the environment resource.', + 'type' => 'array', + 'items' => [ + 'description' => 'Resource tag value.', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'fpx-tag', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'cn-beijing', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'GrafanaDatasourceUid' => ['description' => 'The unique ID of the Grafana data source.', 'type' => 'string', 'example' => '12374890', 'title' => ''], + 'ReleaseCount' => ['description' => 'The number of installed add-ons.', 'type' => 'integer', 'format' => 'int32', 'example' => '122', 'title' => ''], + 'LatestReleaseCreateTime' => ['description' => 'The time when the last add-on was created.', 'type' => 'string', 'example' => '2023-09-22T16:56:29+08:00', 'title' => ''], + 'ManagedType' => ['description' => 'Indicates whether agents or exporters are managed. Valid values:'."\n" + ."\n" + .'- none: No. By default, no managed agents or exporters are provided for ACK clusters.'."\n" + ."\n" + .'- agent: Agents are managed. By default, managed agents are provided for ASK clusters, ACS clusters, and ACK One clusters.'."\n" + ."\n" + .'- agent-exproter: Agents and exporters are managed. By default, managed agents and exporters are provided for cloud services.', 'type' => 'string', 'example' => 'agent', 'title' => ''], + 'FeePackage' => ['description' => 'The payable resource plan.'."\n" + ."\n" + .'- If the EnvironmentType parameter is set to CS, set the value to CS\\_Basic or CS\\_Pro.'."\n" + ."\n" + .'- Otherwise, leave the parameter empty.', 'type' => 'string', 'example' => 'CS_Pro', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Total' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '12', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ResourceIdIsIllegal', - 'errorMessage' => 'The specified ResourceId is invalid.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'AccountUidAccessError', - 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListEnvironments', + 'summary' => 'Queries environments.', + 'changeSet' => [ + ['createdAt' => '2024-07-26T06:37:47.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-05-07T08:24:45.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2024-01-29T08:14:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-23T08:07:33.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvironments'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D80ADAAC-8C32-5479-BD14-C28CF832****\\",\\n \\"Data\\": {\\n \\"status\\": \\"Starting/Running/Stop/DeleteSucceed\\",\\n \\"description\\": \\"\\",\\n \\"grafanaWorkspaceEdition\\": \\"experts_edition/advanced_edition/standard\\",\\n \\"endTime\\": 1652803200000,\\n \\"grafanaWorkspaceId\\": \\"g-thisisademo666\\",\\n \\"upgradeVersion\\": [\\n \\"\\"\\n ],\\n \\"grafanaWorkspaceIp\\": \\"127.0.0.1:3000\\",\\n \\"snatIp\\": \\"1.1.1.1\\",\\n \\"grafanaWorkspaceDomain\\": \\"\\",\\n \\"grafanaWorkspaceDomainStatus\\": \\"on\\",\\n \\"commercial\\": true,\\n \\"grafanaWorkspaceName\\": \\"\\",\\n \\"grafanaVersion\\": \\"\\",\\n \\"gmtCreate\\": 0,\\n \\"userId\\": \\"66666666\\",\\n \\"maxAccount\\": \\"10\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"protocol\\": \\"http/https\\",\\n \\"shareSynced\\": true,\\n \\"ntmId\\": \\"\\",\\n \\"personalDomain\\": \\"\\",\\n \\"personalDomainPrefix\\": \\"\\",\\n \\"resourceGroupId\\": \\"\\",\\n \\"deployType\\": \\"\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"\\",\\n \\"value\\": \\"\\"\\n }\\n ],\\n \\"privateIp\\": \\"\\",\\n \\"privateDomain\\": \\"\\"\\n },\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\"\\n}","type":"json"}]', - 'title' => 'CreateGrafanaWorkspace', - 'description' => 'Before you call the operation, make sure that you have learned about the billing methods and [pricing](https://www.alibabacloud.com/help/zh/grafana/product-overview/billing-4?spm=a2c4g.11186623.0.0.14c2d253B3SDbt) of Managed Service for Grafana.'."\n" - ."\n" - .'> '."\n" - ."\n" - .'* To create workspaces, you must complete real-name verification.'."\n" - ."\n" - .'* Regular users can create workspaces only in Managed Service for Grafana Developer Edition, Pro Edition, and Advanced Edition. `These editions charge fees.`'."\n" - ."\n" - .'* Internal users can create workspaces only in Managed Service for Grafana Beta Edition and Standard Edition. `These editions do not charge fees.`'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Environments\\": [\\n {\\n \\"Addons\\": [\\n {\\n \\"Alias\\": \\"Prometheus探针\\",\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据\\",\\n \\"Icon\\": \\"http://xxxx\\",\\n \\"Name\\": \\"metric-agent\\"\\n }\\n ],\\n \\"UserId\\": \\"13990957477389\\",\\n \\"BindResourceId\\": \\"vpc-bp1bgo8ronn\\",\\n \\"BindResourceProfile\\": \\"xxx\\",\\n \\"BindResourceType\\": \\"VPC\\",\\n \\"BindVpcCidr\\": \\"172.16.0.0/12\\",\\n \\"CreateTime\\": \\"2023-03-24 11:58:35 +0800\\",\\n \\"CreatedUserId\\": \\"12378523784982\\",\\n \\"EnvironmentId\\": \\"env-xxx\\",\\n \\"EnvironmentName\\": \\"feiliks-biz-prod-edas\\",\\n \\"EnvironmentType\\": \\"CS\\",\\n \\"Features\\": [\\n {\\n \\"Alias\\": \\"Prometheus 探针\\",\\n \\"Description\\": \\"以 Prometheus 采集规范采集 Metric 数据\\",\\n \\"Icon\\": \\"http://xxx\\",\\n \\"Name\\": \\"metirc-agent\\"\\n }\\n ],\\n \\"GrafanaFolderTitle\\": \\"filepath\\",\\n \\"GrafanaFolderUid\\": \\"1798319482935\\",\\n \\"PrometheusId\\": 124769812,\\n \\"PrometheusInstanceId\\": \\"vpc-m5e4alj2i24ndbn\\",\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"ResourceGroupId\\": \\"rg-acfmvt3xpr5aema\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"fpx-tag\\",\\n \\"Value\\": \\"cn-beijing\\"\\n }\\n ],\\n \\"GrafanaDatasourceUid\\": \\"12374890\\",\\n \\"ReleaseCount\\": 122,\\n \\"LatestReleaseCreateTime\\": \\"2023-09-22T16:56:29+08:00\\",\\n \\"ManagedType\\": \\"agent\\",\\n \\"FeePackage\\": \\"CS_Pro\\"\\n }\\n ],\\n \\"Total\\": 12\\n }\\n}","type":"json"}]', ], - 'UpdateGrafanaWorkspace' => [ - 'summary' => 'Updates the information about a Grafana workspace.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEscalationPolicies' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GrafanaWorkspaceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'grafana-cn-4xl3g******', - ], - ], - [ - 'name' => 'GrafanaWorkspaceName', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The workspace name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'testGrafana', - ], + 'schema' => ['description' => 'The name of the escalation policy.', 'type' => 'string', 'required' => false, 'example' => 'prod升级策略', 'title' => ''], ], [ - 'name' => 'Description', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The description of the workspace.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - 'Message' => [ - 'description' => 'The error message returned for the request.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* `2XX`: The request is successful.'."\n" - .'* `3XX`: A redirection message is returned.'."\n" - .'* `4XX`: The request is invalid.'."\n" - .'* `5XX`: A server error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TraceId' => [ - 'description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", - 'type' => 'string', - 'example' => 'eac0a8048716731735000007137d000b', - ], - 'Data' => [ - 'description' => 'Indicates whether the update is successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.', 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned objects.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of returned entries.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Size' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20', 'title' => ''], + 'EscalationPolicies' => [ + 'description' => 'The list of escalation policies.', + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the escalation policy.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the escalation policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'Name' => ['description' => 'The name of the escalation policy.', 'type' => 'string', 'example' => 'prod升级策略', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ResourceIdIsIllegal', - 'errorMessage' => 'The specified ResourceId is invalid.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], + 'title' => 'ListEscalationPolicies', + 'summary' => 'Queries the information about an escalation policy.', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPolicies'], ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'AccountUidAccessError', - 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', + ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateGrafanaWorkspace', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"EscalationPolicies\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"prod升级策略\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'UpdateGrafanaWorkspaceVersion' => [ - 'summary' => 'Updates the version of a Grafana workspace.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListEventBridgeIntegrations' => [ + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'GrafanaWorkspaceId', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'grafana-cn-4xl3g******', - ], + 'schema' => ['description' => 'The number of the page to return.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'GrafanaVersion', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => 'The Grafana version.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10.0.x', - ], + 'schema' => ['description' => 'The number of entries to return on each page.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '15', 'title' => ''], ], [ - 'name' => 'AliyunLang', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zh', - ], + 'schema' => ['description' => 'The name of the EventBridge integration.', 'type' => 'string', 'required' => false, 'example' => 'EventBridge_Test', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Message' => [ - 'description' => 'The error message returned for the request.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned for the request. Valid values:'."\n" - ."\n" - .'* `2XX`: The request is successful.'."\n" - .'* `3XX`: A redirection message is returned.'."\n" - .'* `4XX`: The request is invalid.'."\n" - .'* `5XX`: A server error occurs.'."\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', - ], - 'TraceId' => [ - 'description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", - 'type' => 'string', - 'example' => 'eac0a8048716731735000007137d000b', - ], - 'Data' => [ - 'description' => 'Indicates whether the update is successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.', 'type' => 'string', 'example' => '2B289756-E791-5842-BCBD-AD414C******'], + 'PageBean' => [ + 'description' => 'The information about EventBridge integrations that is returned on each page.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['description' => 'The total number of EventBridge integrations that are returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The number of the returned page.', 'type' => 'integer', 'format' => 'int64', 'example' => '1', 'title' => ''], + 'Size' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int64', 'example' => '15', 'title' => ''], + 'EventBridgeIntegrations' => [ + 'description' => 'The EventBridge integrations.', + 'type' => 'array', + 'items' => [ + 'description' => 'The description of the EventBridge integration.', + 'type' => 'object', + 'properties' => [ + 'Id' => ['description' => 'The ID of the EventBridge integration.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Name' => ['description' => 'The name of the EventBridge integration.', 'type' => 'string', 'example' => 'EventBridge_Test', 'title' => ''], + 'Description' => ['description' => 'The description of the EventBridge integration.', 'type' => 'string', 'example' => 'test', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ResourceIdIsIllegal', - 'errorMessage' => 'The specified ResourceId is invalid.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], - ], - 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'AccountUidAccessError', - 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], + 'title' => 'ListEventBridgeIntegrations', + 'summary' => 'Queries EventBridge integrations that are used to push notifications.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEventBridgeIntegrations'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'UpdateGrafanaWorkspaceVersion', - 'description' => 'Note: The list returned by this operation includes the workspaces of Developer Edition, Expert Edition, and Advanced Edition. The list does not include the workspaces of Shared Edition.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2B289756-E791-5842-BCBD-AD414C******\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 15,\\n \\"EventBridgeIntegrations\\": [\\n {\\n \\"Id\\": 123,\\n \\"Name\\": \\"EventBridge_Test\\",\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","type":"json"}]', ], - 'DeleteGrafanaWorkspace' => [ - 'summary' => 'Deletes a Managed Service for Prometheus workspace.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListGrafanaWorkspace' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - 'autoTest' => false, - 'notSupportAutoTestReason' => '涉及数据库任务，为了客户恢复需求，数据库资源不做释放，自动化调用资源浪费', - ], + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GrafanaWorkspaceId', + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'Tags', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the workspace.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'grafana-rnglkcdrntlhk0****', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], + ], ], 'responses' => [ 200 => [ @@ -27090,251 +21623,94 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\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', - ], - 'TraceId' => [ - 'description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", - 'type' => 'string', - 'example' => 'eac0a8048716731735000007137d000b', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '0080BE65-167F-5CB6-A691-14E2EFD474BC'], 'Data' => [ - 'description' => 'Indicates whether the workspace was deleted. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned result.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The information about the Grafana workspace.'."\n", '$ref' => '#/components/schemas/GrafanaWorkspace', 'title' => '', 'example' => ''], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The error message returned if the request parameters are invalid.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'TraceId' => ['description' => 'The trace ID that is used to query the details of the request.'."\n", 'type' => 'string', 'example' => 'eac0a8048716731735000007137d000b', 'title' => ''], ], + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ResourceIdIsIllegal', - 'errorMessage' => 'The specified ResourceId is invalid.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ResourceIdIsIllegal', 'errorMessage' => 'The specified ResourceId is invalid.', 'description' => 'The parameter ResourceId is illegal.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], ], 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], ], 500 => [ - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], - [ - 'errorCode' => 'AccountUidAccessError', - 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', - ], + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['errorCode' => 'AccountUidAccessError', 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListGrafanaWorkspace', + 'summary' => 'Obtain Specified Workspace List', + 'description' => '>The list returned by this operation includes the workspaces of Developer Edition, Expert Edition, and Advanced Edition. The list does not include the workspaces of Shared Edition.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGrafanaWorkspace'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteGrafanaWorkspace', - 'description' => '* You can delete workspaces only in Managed Service for Prometheus Beta Edition, which is `free of charge`.'."\n" - ."\n" - .'* You cannot delete workspaces in Managed Service for Prometheus Developer Edition, Pro Edition, and Advanced Edition. You can go to the [User Center](https://usercenter2.aliyun.com/refund/refund) to unsubscribe from workspaces.', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"0080BE65-167F-5CB6-A691-14E2EFD474BC\\",\\n \\"Data\\": [\\n {\\n \\"status\\": \\"Starting、Running、Stop、DeleteSucceed\\",\\n \\"description\\": \\"线上生产环境Grafana\\",\\n \\"grafanaWorkspaceEdition\\": \\"personal_edition、experts_edition、advanced_edition、standard\\",\\n \\"endTime\\": 1652803200000,\\n \\"grafanaWorkspaceId\\": \\"grafana-cn-4xl3g******\\",\\n \\"upgradeVersion\\": [\\n \\"9.0.x\\"\\n ],\\n \\"grafanaWorkspaceIp\\": \\"47.110.71.***:443\\",\\n \\"snatIp\\": \\"47.110.71.***\\",\\n \\"grafanaWorkspaceDomain\\": \\"my-grafana.grafana.aliyuncs.com:443\\",\\n \\"grafanaWorkspaceDomainStatus\\": \\"on\\",\\n \\"commercial\\": true,\\n \\"grafanaWorkspaceName\\": \\"线上生产环境Grafana\\",\\n \\"grafanaVersion\\": \\"9.0.x\\",\\n \\"gmtCreate\\": 1642079398000,\\n \\"userId\\": \\"1412143830******\\",\\n \\"maxAccount\\": \\"10\\",\\n \\"regionId\\": \\"cn-hangzhou\\",\\n \\"protocol\\": \\"http、https\\",\\n \\"shareSynced\\": true,\\n \\"ntmId\\": \\"grafana-cn-4xl3g******\\",\\n \\"personalDomain\\": \\"my-grafana.grafana.aliyuncs.com:443\\",\\n \\"personalDomainPrefix\\": \\"my-grafana\\",\\n \\"resourceGroupId\\": \\"rg-aek2f4vzrfs6cla\\",\\n \\"deployType\\": \\"asi\\",\\n \\"tags\\": [\\n {\\n \\"key\\": \\"TestKey\\",\\n \\"value\\": \\"TestValue\\"\\n }\\n ],\\n \\"privateIp\\": \\"192.168.1.1\\\\n\\",\\n \\"privateDomain\\": \\"my-grafana.grafana.aliyuncs.com:80\\"\\n }\\n ],\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\"\\n}","type":"json"}]', ], - 'ApplyScenario' => [ - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListInsightsEvents' => [ + 'summary' => 'Queries the abnormal Insights events within a specified period of time.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjaikou', - ], - ], - [ - 'name' => 'Scenario', - 'in' => 'query', - 'schema' => [ - 'description' => 'The scenario where you want to use the business monitoring job. Valid values:'."\n" - ."\n" - .'* `USER-DEFINED`: user-defined. This is the default value.'."\n" - .'* `EDAS-ROLLOUT`: application release in Enterprise Distributed Application Service (EDAS)'."\n" - .'* `OAM-ROLLOUT`: application release based on Open Application Model (OAM)'."\n" - .'* `MSC-CANARY`: canary release based on Microservice Engine (MSE)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER-DEFINED', - ], - ], - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the business monitoring job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'ScenarioName', - ], - ], - [ - 'name' => 'AppId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b590lhguqs@28f515462f******', - ], + 'schema' => ['title' => '', 'description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou'], ], [ - 'name' => 'Sign', - 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the business monitoring job. This parameter is not required when you create a business monitoring job. However, this parameter is required when you update a business monitoring job.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'a9f8****', - ], - ], - [ - 'name' => 'Config', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The configuration of the business monitoring job. The value is a JSON string. For more information about this parameter, see the following additional information about the **Config** parameter.'."\n", - 'type' => 'object', - 'required' => true, - 'docRequired' => true, - 'example' => '{"rpcType":"0","nameMatchType":"EQUALS","service":"/api/pop/test","operator":"and","filterItems":[{"type":"HttpHeaders","key":"uid","opt":"==","value":"123456789"}],"group":{"type":"HttpRequestParameters","key":"name"}}', - ], - ], - [ - 'name' => 'SnTransfer', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the coloring sign is transparently passed down to downstream application nodes in the trace.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`: This is the default value.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'SnStat', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to count traffic based on the coloring sign.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`: This is the default value.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aokcdqn3ly@a195c6d6421****', 'title' => ''], ], [ - 'name' => 'SnDump', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to record business parameters to the trace marked with the coloring sign.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`: This is the default value.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The start of the time range to query. The value is a timestamp.'."\n", 'type' => 'string', 'required' => true, 'example' => '1595174400000', 'title' => ''], ], [ - 'name' => 'SnForce', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether traffic in the trace marked with the coloring sign is all collected.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`: This is the default value.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The end of the time range to query. The value is a timestamp.'."\n", 'type' => 'string', 'required' => true, 'example' => '1480607940000', 'title' => ''], ], [ - 'name' => 'UpdateOption', + 'name' => 'InsightsTypes', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the operation is an update operation.'."\n" - ."\n" - .'* `true`: update'."\n" - .'* `false`: insert'."\n", - 'type' => 'boolean', - 'required' => true, - 'docRequired' => true, - 'example' => 'false', - ], + 'schema' => ['description' => 'The types of the events that you want to query. Separate multiple event types with commas (,). If you do not specify this parameter, all events are queried.'."\n" + ."\n" + .'* errorIncrease: API error-rate spike events. Examples: HTTP API error-rate spike events and Dubbo API error-rate spike events.'."\n" + .'* topErrorIncrease: the top five API error-rate spike events with the highest traffic.'."\n" + .'* topRtIncrease: API response-time spike events. Examples: HTTP API response-time spike events and Dubbo API response-time spike events.'."\n" + .'* rtIncrease: the top five API response-time spike events with the highest traffic.'."\n", 'type' => 'string', 'required' => false, 'example' => 'errorIncrease,topErrorIncrease,topExceptionIncrease,topRtIncrease,rtIncrease', 'title' => ''], ], ], 'responses' => [ @@ -27342,3563 +21718,1689 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'The code of the business monitoring job, which is the coloring sign.'."\n", - 'type' => 'string', - 'example' => '2b97****', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EA24D522-AD35-47B8-8CB2-ADBC38******', + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6F1174DC-6085-5353-AAE7-D4ADCD******'], + 'InsightsEvents' => [ + 'description' => 'The details of the event.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Title' => ['description' => 'The title of the event.'."\n", 'type' => 'string', 'example' => '应用服务整体平均响应时间突增', 'title' => ''], + 'Desc' => ['description' => 'The description of the alert event.'."\n", 'type' => 'string', 'example' => '应用【sd】【HTTP】服务整体的响应时间在【2022-07-27 10:57:00】出现突增', 'title' => ''], + 'Type' => ['description' => 'The type of the event.'."\n", 'type' => 'string', 'example' => 'rtIncrease', 'title' => ''], + 'Pid' => ['description' => 'The ID of the application associated with the event.'."\n", 'type' => 'string', 'example' => 'dsv9zcel92@7da413b******', 'title' => ''], + 'Level' => ['description' => 'The severity of the event.'."\n", 'type' => 'string', 'example' => 'P3', 'title' => ''], + 'Date' => ['description' => 'The time when the event occurred. The value is a timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1658890560', 'title' => ''], + 'ProblemId' => ['description' => 'The problem identifier.'."\n", 'type' => 'string', 'example' => 'erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": \\"2b97****\\",\\n \\"RequestId\\": \\"EA24D522-AD35-47B8-8CB2-ADBC38******\\"\\n}","errorExample":""},{"type":"xml","example":"<ApplyScenarioResponse>\\n <RequestId>EA24D522-AD35-47B8-8CB2-ADBC38******</RequestId>\\n <Result>2b97****</Result>\\n</ApplyScenarioResponse>","errorExample":""}]', - 'title' => 'ApplyScenario', - 'requestParamsDescription' => '## Additional information about the **Config** parameter'."\n" - ."\n" - .'**JSON string example and description**'."\n" - ."\n" - .'```'."\n" - ."\n" - .'{'."\n" - .' "rpcType":"0", //The service type. 0: HTTP ingress. 255: Kubernete Pod Metadata.'."\n" - .' "nameMatchType":"EQUALS", //The matching mode of the service name. EQUALS: equal. STARTSWITH: equal to the start. CONTAINS: contains. ENDSWITH: equal to the end. PATTERNS: mode matching.'."\n" - .' "service":"/api/pop/test", // The name of the service.'."\n" - .' "operator":"and", //The relationship among filter rules. and: All the rules are met. or: A rule is met.'."\n" - .' "filterItems": //The filter rules.'."\n" - .' [{'."\n" - .' "type":"HttpHeaders", //The matching parameters for the filter rules. For more information, see the next section.'."\n" - .' "key":"uid", //The value of the key that matches the filter field.'."\n" - .' "opt":"==", //The matching mode. Support ==, !=, and contains.'."\n" - .' "value":"123456789" //The threshold of the filter field.'."\n" - .' }],'."\n" - .' "group": //The grouping rule.'."\n" - .' {'."\n" - .' "type":"HttpRequestParameters", //The matching parameters for the grouping rule. For more information, see the next section.'."\n" - .' "key":"name" //The value of the key that matches the grouping rule.'."\n" - .' }'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'**Matching parameters for the filter rules**'."\n" - ."\n" - .'When rpcType is set to 0, the service type is HTTP ingress and the matching parameters are the following parameters:'."\n" - ."\n" - .'* HttpRequestParameters'."\n" - .'* HttpHeaders'."\n" - .'* HttpCookies'."\n" - .'* HttpMethod'."\n" - .'* HttpPathVariables'."\n" - ."\n" - .'When rpcType is set to 255, the service type is Kubernete Pod Metadata and the matching parameters are the following parameters:'."\n" - ."\n" - .'* k8sPodLabel'."\n" - .'* k8sPodAnnotation'."\n" - .'* k8sPodName'."\n" - .'* k8sPodNamespace'."\n" - .'* k8sPodUID'."\n" - .'* k8sPodIp'."\n" - .'* k8sPodServiceAccount'."\n" - ."\n" - .'**Matching parameters for the grouping rule**'."\n" - ."\n" - .'When rpcType is set to 0, the service type is HTTP ingress and the matching parameters are the following parameters:'."\n" - ."\n" - .'* HttpRequestParameters'."\n" - .'* HttpHeaders'."\n" - .'* HttpCookies'."\n" - .'* HttpMethod'."\n" - .'* HttpPathVariables'."\n" - ."\n" - .'When rpcType is set to 255, the service type is Kubernete Pod Metadata and the matching parameters are the following parameters:'."\n" - ."\n" - .'* k8sPodLabel'."\n" - .'* k8sPodAnnotation'."\n" - .'* k8sPodName'."\n" - .'* k8sPodNamespace'."\n" - .'* k8sPodUID'."\n" - .'* k8sPodIp'."\n" - .'* k8sPodServiceAccount'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteScenario' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6F1174DC-6085-5353-AAE7-D4ADCD******\\",\\n \\"InsightsEvents\\": [\\n {\\n \\"Title\\": \\"应用服务整体平均响应时间突增\\",\\n \\"Desc\\": \\"应用【sd】【HTTP】服务整体的响应时间在【2022-07-27 10:57:00】出现突增\\",\\n \\"Type\\": \\"rtIncrease\\",\\n \\"Pid\\": \\"dsv9zcel92@7da413b******\\",\\n \\"Level\\": \\"P3\\",\\n \\"Date\\": 1658890560,\\n \\"ProblemId\\": \\"erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'ListInsightsEvents', + 'changeSet' => [ + ['createdAt' => '2023-10-19T11:53:05.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-22T03:37:20.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListIntegration' => [ + 'summary' => 'Views a list of alert integrations.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ScenarioId', + 'name' => 'IntegrationName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the business monitoring job. You can obtain the ID by calling the ListScenario operation.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '1', - 'example' => '132', - ], + 'schema' => ['title' => '', 'description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'required' => false, 'example' => '云监控集成'], ], [ - 'name' => 'RegionId', + 'name' => 'IntegrationProductType', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjaikou', - ], + 'schema' => ['title' => '', 'description' => 'The type of the alert integration. Valid values:'."\n" + ."\n" + .'* CLOUD_MONITOR: CloudMonitor'."\n" + .'* LOG_SERVICE: Log Service'."\n", 'type' => 'string', 'required' => true, 'example' => 'CLOUD_MONITOR'], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of alert integrations to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '10'], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to display the details of each alert integration:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Result' => [ - 'description' => 'Indicates whether the request is successful.'."\n" - ."\n" - .'* `true`: successful'."\n" - .'* `false`: failed'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'EA24D522-AD35-47B8-8CB2-ADBC382B****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****'], + 'PageInfo' => [ + 'title' => '', + 'description' => 'The pagination information.'."\n", + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The total number of alert integrations.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of alert integrations returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '10'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Integrations' => [ + 'description' => 'The information about each alert integration.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IntegrationId' => ['title' => '', 'description' => 'The ID of the alert integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'IntegrationName' => ['title' => '', 'description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'example' => '云监控集成'], + 'IntegrationProductType' => ['title' => '', 'description' => 'The type of the alert integration. Valid values:'."\n" + ."\n" + .'* CLOUD_MONITOR: CloudMonitor'."\n" + .'* LOG_SERVICE: Log Service'."\n", 'type' => 'string', 'example' => 'CLOUD_MONITOR'], + 'ApiEndpoint' => ['title' => '', 'description' => 'The endpoint of the alert integration.'."\n", 'type' => 'string', 'example' => 'https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******'], + 'ShortToken' => ['title' => '', 'description' => 'The authentication token of the alert integration.'."\n", 'type' => 'string', 'example' => 'ymQBN******'], + 'State' => ['title' => '', 'description' => 'Indicates whether the alert integration was enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'Liveness' => ['title' => '', 'description' => 'The activity of the alert integration'."\n", 'type' => 'string', 'example' => 'ready'], + 'CreateTime' => ['title' => '', 'description' => 'The time when the alert integration was created.'."\n", 'type' => 'string', 'example' => '2022-06-18'], + 'IntegrationDetail' => [ + 'title' => '', + 'description' => 'The information about the alert events.'."\n", + 'type' => 'object', + 'properties' => [ + 'Description' => ['title' => '', 'description' => 'The description of the alert integration.'."\n", 'type' => 'string', 'example' => '测试'], + 'DuplicateKey' => ['title' => '', 'description' => 'The fields whose values are deduplicated.'."\n", 'type' => 'string', 'example' => 'LABEL.alertname::LABEL.severity'], + 'AutoRecover' => ['title' => '', 'description' => 'Indicates whether alert events are automatically cleared. Valid values:'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true'], + 'RecoverTime' => ['title' => '', 'description' => 'The time when alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300'], + 'Stat' => [ + 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '[0,0]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'FieldRedefineRules' => [ + 'description' => 'The predefined mapped fields of the alert source.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created.'."\n", 'type' => 'object', 'example' => '['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"alertname",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警名称",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.alertName",'."\n" + .' "id":10001,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"MAP",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"severity",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + .' {'."\n" + .' "mappingValue":"critical",'."\n" + .' "mappingName":"P1",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"CRITICAL"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"error",'."\n" + .' "mappingName":"P2",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"WARN"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"warning",'."\n" + .' "mappingName":"P3",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"INFO"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"告警等级",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.triggerLevel",'."\n" + .' "id":10002,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"message",'."\n" + .' "expression":"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警描述",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10003,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"value",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警样本值",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.curValue",'."\n" + .' "id":10004,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"source",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"来源",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10007,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"ADD",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"generatorUrl",'."\n" + .' "expression":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"事件地址",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "id":10012,'."\n" + .' "fieldType":"GENERATE_URL"'."\n" + .' }'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'ExtendedFieldRedefineRules' => [ + 'description' => 'The extended mapped fields of the alert source.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The extended mapped fields are mapped to the fields of ARMS alerts.'."\n", 'type' => 'object', 'example' => '['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"dimensions",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"dimensions",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.dimensions",'."\n" + .' "id":10013,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"expression",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"expression",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.expression",'."\n" + .' "id":10014,'."\n" + .' "fieldType":"LABEL"'."\n" + .' }'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'InitiativeRecoverField' => ['description' => 'The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" + ."\n" + .'> Only the Log Service alert integration supports the parameter.'."\n", 'type' => 'string', 'example' => '$.status', 'title' => ''], + 'InitiativeRecoverValue' => ['description' => 'The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" + ."\n" + .'> Only the Log Service alert integration supports the parameter.'."\n", 'type' => 'string', 'example' => 'ok', 'title' => ''], + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Result\\": true,\\n \\"RequestId\\": \\"EA24D522-AD35-47B8-8CB2-ADBC382B****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteScenarioResponse>\\n <RequestId>EA24D522-AD35-47B8-8CB2-ADBC382B****</RequestId>\\n <Result>true</Result>\\n</DeleteScenarioResponse>","errorExample":""}]', - 'title' => 'DeleteScenario', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListScenario' => [ - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"PageInfo\\": {\\n \\"Total\\": 1,\\n \\"Size\\": 10,\\n \\"Page\\": 1,\\n \\"Integrations\\": [\\n {\\n \\"IntegrationId\\": 1234,\\n \\"IntegrationName\\": \\"云监控集成\\",\\n \\"IntegrationProductType\\": \\"CLOUD_MONITOR\\",\\n \\"ApiEndpoint\\": \\"https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******\\",\\n \\"ShortToken\\": \\"ymQBN******\\",\\n \\"State\\": true,\\n \\"Liveness\\": \\"ready\\",\\n \\"CreateTime\\": \\"2022-06-18\\",\\n \\"IntegrationDetail\\": {\\n \\"Description\\": \\"测试\\",\\n \\"DuplicateKey\\": \\"LABEL.alertname::LABEL.severity\\",\\n \\"AutoRecover\\": true,\\n \\"RecoverTime\\": 300,\\n \\"Stat\\": [\\n 0\\n ],\\n \\"FieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"alertname\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警名称\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.alertName\\",\\n \\"id\\": 10001,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"MAP\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"severity\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [\\n {\\n \\"mappingValue\\": \\"critical\\",\\n \\"mappingName\\": \\"P1\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"CRITICAL\\"\\n },\\n {\\n \\"mappingValue\\": \\"error\\",\\n \\"mappingName\\": \\"P2\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"WARN\\"\\n },\\n {\\n \\"mappingValue\\": \\"warning\\",\\n \\"mappingName\\": \\"P3\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"INFO\\"\\n }\\n ],\\n \\"name\\": \\"告警等级\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.triggerLevel\\",\\n \\"id\\": 10002,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"message\\",\\n \\"expression\\": \\"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警描述\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10003,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"value\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警样本值\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.curValue\\",\\n \\"id\\": 10004,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"source\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"来源\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10007,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"ADD\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"generatorUrl\\",\\n \\"expression\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"事件地址\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"id\\": 10012,\\n \\"fieldType\\": \\"GENERATE_URL\\"\\n }\\n ]\\n ],\\n \\"ExtendedFieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"dimensions\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"dimensions\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.dimensions\\",\\n \\"id\\": 10013,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"expression\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"expression\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.expression\\",\\n \\"id\\": 10014,\\n \\"fieldType\\": \\"LABEL\\"\\n }\\n ]\\n ],\\n \\"InitiativeRecoverField\\": \\"$.status\\",\\n \\"InitiativeRecoverValue\\": \\"ok\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListIntegration', + 'changeSet' => [ + ['createdAt' => '2022-08-11T08:16:19.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-08-11T02:43:11.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegration'], + ], ], + 'ramActions' => [], + ], + 'ListNotificationPolicies' => [ + 'summary' => 'Queries notification policies based on specified conditions.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-zhangjaikou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'notificationpolicy_test'], ], [ - 'name' => 'Scenario', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The scenario where the business monitoring job is used. Valid values:'."\n" - ."\n" - .'* `USER-DEFINED`: user-defined. This is the default value.'."\n" - .'* `EDAS-ROLLOUT`: application release in Enterprise Distributed Application Service (EDAS)'."\n" - .'* `OAM-ROLLOUT`: application release based on Open Application Model (OAM)'."\n" - .'* `MSC-CANARY`: canary release based on Microservice Engine (MSE)'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'USER-DEFINED', - ], + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'Name', + 'name' => 'Size', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the business monitoring job.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'pro-content', - ], + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], ], [ - 'name' => 'AppId', + 'name' => 'IsDetail', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'b590lhguqs@28f515462******', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to query the details about notification policies. Valid values:'."\n" + ."\n" + .'* `true`: Details about notification policies are queried.'."\n" + .'* `false`: Details about notification policies are not queried.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ - 'name' => 'Sign', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The code of the business monitoring job. Set this parameter when you know the code of the business monitoring job you want to query.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a9f8****', - ], + 'schema' => ['description' => 'The ID of the region. Default value: **cn-hangzhou**.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the notification policy.'."\n", 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], + ], + [ + 'name' => 'DirectedMode', + 'in' => 'query', + 'schema' => ['title' => '极简模式', 'description' => 'Specifies whether to enable simple mode.', 'type' => 'boolean', 'required' => false, 'example' => 'true'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '98027D1F-3AEB-492C-A4AA-E9217992****', - ], - 'ArmsScenarios' => [ - 'description' => 'The detailed information of the business monitoring job.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the business monitoring job was updated.'."\n", - 'type' => 'string', - 'example' => '1585214916000', - ], - 'AppId' => [ - 'description' => 'The ID of the application.'."\n", - 'type' => 'string', - 'example' => 'b590lhguqs@28f515462******', - ], - 'Sign' => [ - 'description' => 'The code of the business monitoring job.'."\n", - 'type' => 'string', - 'example' => 'a9f8****', - ], - 'CreateTime' => [ - 'description' => 'The time when the business monitoring job was created.'."\n", - 'type' => 'string', - 'example' => '1585214916000', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'Extensions' => [ - 'description' => 'The extended information. The value is a JSON string.'."\n", - 'type' => 'string', - 'example' => '{"_MODE": "CUSTOM-TRANSACTION","_SCENARIO": "USER-DEFINED"}', - ], - 'Name' => [ - 'description' => 'The name of the business monitoring job.'."\n", - 'type' => 'string', - 'example' => 'k8s_deployment_css-guns-vip-main-prod_silence', - ], - 'Id' => [ - 'description' => 'The ID of the business monitoring job.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '132', - ], - 'RegionId' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou', + 'RequestId' => ['title' => '', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned pages.', + 'type' => 'object', + 'properties' => [ + 'Total' => ['title' => '', 'description' => 'The number of notification policies that are returned.', 'type' => 'integer', 'format' => 'int64', 'example' => '24'], + 'Page' => ['title' => '', 'description' => 'The number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of entries that are returned on each page.', 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'NotificationPolicies' => [ + 'title' => '', + 'description' => 'The queried notification policies.', + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the notification policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The name of the notification policy.'."\n", 'type' => 'string', 'example' => 'notificationpolicy_test'], + 'MatchingRules' => [ + 'title' => '', + 'description' => 'The matching rules for alert events.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'title' => '', + 'description' => 'The matching conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The key of the matching condition.'."\n", 'type' => 'string', 'example' => 'altertname'], + 'Value' => ['title' => '', 'description' => 'The value of the matching condition.'."\n", 'type' => 'string', 'example' => 'test'], + 'Operator' => ['title' => '', 'description' => 'The logical operator of the matching condition. Valid values:'."\n" + ."\n" + .'* `eq`: equal to'."\n" + .'* `neq`: not equal to'."\n" + .'* `in`: contains'."\n" + .'* `nin`: does not contain'."\n" + .'* `re`: regular expression match'."\n" + .'* `nre`: regular expression mismatch'."\n", 'type' => 'string', 'example' => 'eq'], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + 'SendRecoverMessage' => ['title' => '', 'description' => 'Indicates whether the status of an alert automatically changes to Resolved when all events related to the alert change to the Restored state. The system sends a notification to the alert contacts when the alert status changes to Resolved.'."\n" + ."\n" + .'- `true` (default): The system sends a notification.'."\n" + .'- `false`: The system does not send a notification.', 'type' => 'boolean', 'example' => 'true'], + 'GroupRule' => [ + 'title' => '', + 'description' => 'The grouping rule for alert events.', + 'type' => 'object', + 'properties' => [ + 'GroupingFields' => [ + 'title' => '', + 'description' => 'An array of alert event group objects.'."\n" + ."\n" + .'* If you do not specify the groupingFields field, all alerts will be sent to contacts based on `alertname`.'."\n" + .'* If you specify the groupingFields field, alerts with the same field will be sent to contacts in one notification.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The field that is used for grouping.'."\n", 'type' => 'string', 'example' => '["alertname"]', 'title' => ''], + 'example' => '', + ], + 'GroupWait' => ['title' => '', 'description' => 'The waiting time for grouping. Unit: seconds. Default value: 5.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '5'], + 'GroupInterval' => ['title' => '', 'description' => 'The time interval of grouping. Unit: seconds. Default value: 30.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '30'], + ], + 'example' => '', + ], + 'NotifyRule' => [ + 'title' => '', + 'description' => 'The notification rule.', + 'type' => 'object', + 'properties' => [ + 'NotifyStartTime' => ['title' => '', 'description' => 'The start time of the notification window.'."\n", 'type' => 'string', 'example' => '00:00'], + 'NotifyEndTime' => ['title' => '', 'description' => 'The end time of the notification window.'."\n", 'type' => 'string', 'example' => '23:59'], + 'NotifyChannels' => [ + 'title' => '', + 'description' => 'The notification method.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The notification methods. Valid values:'."\n" + ."\n" + .'* `dingTalk`: DingTalk'."\n" + .'* `email`: email'."\n" + .'* `sms`: text message'."\n" + .'* `tts`: phone call'."\n" + .'* `webhook`: webhook'."\n", 'type' => 'string', 'example' => '[ "dingTalk", "email", "sms", "tts","webhook" ]', 'title' => ''], + 'example' => '', + ], + 'NotifyObjects' => [ + 'title' => '', + 'description' => 'The notification objects.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyObjectType' => ['title' => '', 'description' => 'The type of the notification object. Valid values:'."\n" + ."\n" + .'- CONTACT: an individual contact'."\n" + .'- CONTACT_GROUP: a contact group'."\n" + .'- DING_ROBOT: an instant messaging (IM) chatbot'."\n" + .'- CONTACT_SCHEDULE: a person on duty based on an established schedule', 'type' => 'string', 'example' => 'CONTACT'], + 'NotifyObjectId' => ['title' => '', 'description' => 'The ID of the notification object.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'NotifyObjectName' => ['title' => '', 'description' => 'The name of the notification object.'."\n", 'type' => 'string', 'example' => 'test'], + 'NotifyChannels' => [ + 'title' => '通知对象为联系人时的联系方式', + 'description' => 'The notification methods specified for a contact.', + 'type' => 'array', + 'items' => ['description' => 'The notification methods.'."\n" + ."\n" + .'- `email`: email'."\n" + .'- `sms`: text message'."\n" + .'- `tts`: phone call', 'type' => 'string', 'example' => '[ "email", "sms", "tts" ]', 'title' => ''], + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'example' => '', + ], + ], + 'example' => '', + ], + 'NotifyTemplate' => [ + 'title' => '', + 'description' => 'The notification template.'."\n", + 'type' => 'object', + 'properties' => [ + 'EmailTitle' => ['title' => '', 'description' => 'The title of the alert notification sent by email.', 'type' => 'string', 'example' => '{{ .commonLabels.alertname }}'], + 'EmailContent' => ['title' => '', 'description' => 'The content of the alert notification sent by email.', 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href="{{.generatorURL}}" > 详情链接</a> {{ end }} {{ end }}'], + 'EmailRecoverTitle' => ['title' => '', 'description' => 'The title of the alert resolution notification sent by email.', 'type' => 'string', 'example' => '{{ .commonLabels.alertname }}'], + 'EmailRecoverContent' => ['title' => '', 'description' => 'The content of the alert resolution notification sent by email.', 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href="{{.generatorURL}}" > 详情链接</a> {{ end }} {{ end }}'], + 'SmsContent' => ['title' => '', 'description' => 'The content of the alert notification sent by text message.', 'type' => 'string', 'example' => '发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'SmsRecoverContent' => ['title' => '', 'description' => 'The content of the alert resolution notification sent by text message.', 'type' => 'string', 'example' => '告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'TtsContent' => ['title' => '', 'description' => 'The content of the alert notification sent by phone.', 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'TtsRecoverContent' => ['title' => '', 'description' => 'The content of the alert resolution notification sent by phone.', 'type' => 'string', 'example' => '告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}'], + 'RobotContent' => ['title' => '', 'description' => 'The content of the alert notification sent by an IM chatbot.', 'type' => 'string', 'example' => '{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq "true" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}'], + ], + 'example' => '', + ], + 'Repeat' => ['title' => '', 'description' => 'Indicates whether the system resends notifications for a long-lasting unresolved alert. Valid values:'."\n" + ."\n" + .'- `true` (default): The system resends notifications for a long-lasting unresolved alert at a specified time interval.'."\n" + .'- `false`: The system resends notifications for a long-lasting unresolved alert based on an escalation policy.', 'type' => 'boolean', 'example' => 'true'], + 'RepeatInterval' => ['title' => '', 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '600'], + 'EscalationPolicyId' => ['title' => '', 'description' => 'The ID of the escalation policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'IntegrationId' => ['title' => '', 'description' => 'The integration ID of the ticket system to which alerts are pushed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '34'], + 'DirectedMode' => ['title' => '极简模式', 'description' => 'Indicates whether simple mode is enabled.', 'type' => 'boolean', 'example' => 'true'], + 'State' => ['title' => '通知策略是否启用，enable 启用，disable 停用', 'description' => 'Indicates whether the notification policy is enabled. Valid values: enable and disable.', 'type' => 'string', 'example' => 'enable'], + ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"98027D1F-3AEB-492C-A4AA-E9217992****\\",\\n \\"ArmsScenarios\\": [\\n {\\n \\"UpdateTime\\": \\"1585214916000\\",\\n \\"AppId\\": \\"b590lhguqs@28f515462******\\",\\n \\"Sign\\": \\"a9f8****\\",\\n \\"CreateTime\\": \\"1585214916000\\",\\n \\"UserId\\": \\"113197164949****\\",\\n \\"Extensions\\": \\"{\\\\\\"_MODE\\\\\\": \\\\\\"CUSTOM-TRANSACTION\\\\\\",\\\\\\"_SCENARIO\\\\\\": \\\\\\"USER-DEFINED\\\\\\"}\\",\\n \\"Name\\": \\"测试业务监控\\",\\n \\"Id\\": 132,\\n \\"RegionId\\": \\"cn-zhangjiakou\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListScenarioResponse>\\n<RequestId>98027D1F-3AEB-492C-A4AA-E9217992****</RequestId>\\n<ArmsScenarios>\\n <AppId>b590lhguqs@28f515462******</AppId>\\n <UserId>113197164949****</UserId>\\n <CreateTime>1585214916000</CreateTime>\\n <UpdateTime>1585214916000</UpdateTime>\\n <Sign>a9f8****</Sign>\\n <RegionId>cn-zhangjiakou</RegionId>\\n <Id>132</Id>\\n <Extensions>{\\"_MODE\\": \\"CUSTOM-TRANSACTION\\",\\"_SCENARIO\\": \\"USER-DEFINED\\"}</Extensions>\\n <Name>测试业务监控</Name>\\n</ArmsScenarios>\\n</ListScenarioResponse>","errorExample":""}]', - 'title' => 'ListScenario', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateTimingSyntheticTask' => [ - 'summary' => 'Creates a scheduled synthetic test task.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 24,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"NotificationPolicies\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"notificationpolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"SendRecoverMessage\\": true,\\n \\"GroupRule\\": {\\n \\"GroupingFields\\": [\\n \\"[\\\\\\"alertname\\\\\\"]\\"\\n ],\\n \\"GroupWait\\": 5,\\n \\"GroupInterval\\": 30\\n },\\n \\"NotifyRule\\": {\\n \\"NotifyStartTime\\": \\"00:00\\",\\n \\"NotifyEndTime\\": \\"23:59\\",\\n \\"NotifyChannels\\": [\\n \\"[ \\\\\\"dingTalk\\\\\\", \\\\\\"email\\\\\\", \\\\\\"sms\\\\\\", \\\\\\"tts\\\\\\",\\\\\\"webhook\\\\\\" ]\\"\\n ],\\n \\"NotifyObjects\\": [\\n {\\n \\"NotifyObjectType\\": \\"CONTACT\\",\\n \\"NotifyObjectId\\": 123,\\n \\"NotifyObjectName\\": \\"test\\",\\n \\"NotifyChannels\\": [\\n \\"[ \\\\\\"email\\\\\\", \\\\\\"sms\\\\\\", \\\\\\"tts\\\\\\" ]\\"\\n ]\\n }\\n ]\\n },\\n \\"NotifyTemplate\\": {\\n \\"EmailTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"EmailRecoverTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"SmsContent\\": \\"发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"SmsRecoverContent\\": \\"告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"RobotContent\\": \\"{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq \\\\\\"true\\\\\\" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}\\"\\n },\\n \\"Repeat\\": true,\\n \\"RepeatInterval\\": 600,\\n \\"EscalationPolicyId\\": 123,\\n \\"IntegrationId\\": 34,\\n \\"DirectedMode\\": true,\\n \\"State\\": \\"enable\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListNotificationPolicies', + 'changeSet' => [ + ['createdAt' => '2024-06-19T03:07:27.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-08-17T11:53:00.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-03-30T06:16:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-11-17T08:05:35.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-07-13T14:39:18.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNotificationPolicies'], + ], ], + 'ramActions' => [], + ], + 'ListOnCallSchedules' => [ + 'summary' => 'Queries the information about a scheduling policy.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'title' => '地域ID。', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'title' => '拨测任务名称，不允许重复。', - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'demo-test', - ], + 'schema' => ['title' => '', 'description' => 'The name of the scheduling policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'OnCallSchedule_test'], ], [ - 'name' => 'TaskType', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'title' => '任务类型：'."\n" - .'1：ICMP'."\n" - .'2：TCP'."\n" - .'3：DNS'."\n" - .'4：HTTP'."\n" - .'5：网站测速'."\n" - .'6：文件下载'."\n", - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed measurement. 6: file download.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '4', - ], + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], ], [ - 'name' => 'MonitorConf', + 'name' => 'Size', 'in' => 'query', - 'style' => 'json', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '监测配置。', - 'description' => 'The monitoring configurations.'."\n", + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'NetICMP' => [ - 'title' => 'ICMP拨测配置参数。当TaskType为1时必填。', - 'description' => 'The parameters of the ICMP synthetic test. This parameter is required if the TaskType parameter is set to 1.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'title' => '拨测目标地址（主机）。', - 'description' => 'The destination IP address or domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com', - ], - 'Interval' => [ - 'title' => 'ICMP（Ping）数据包发送的时间间隔。单位为毫秒(ms)，最小值为200，最大值为2000，默认为200。', - 'description' => 'The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 2000. Default value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'PackageNum' => [ - 'title' => '发送ICMP（Ping）数据包的数量。最小值为1，最大值为16，默认为4。', - 'description' => 'The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'PackageSize' => [ - 'title' => '发送ICMP（Ping）数据包的大小。单位为byte，允许设置为32, 64, 128, 256, 512, 1024。', - 'description' => 'The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024, 1080, and 1450.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'enumValueTitles' => [], - 'example' => '32', - ], - 'SplitPackage' => [ - 'title' => '是否拆分ICMP（Ping）数据包。默认为true。', - 'description' => 'Specifies whether to split ICMP packets. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'Timeout' => [ - 'title' => 'ICMP拨测的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', - 'description' => 'The timeout period for the ICMP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20000', - ], - 'TracertEnable' => [ - 'title' => '是否开启tracert。默认为true。', - 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TracertNumMax' => [ - 'title' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', - 'description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'TracertTimeout' => [ - 'title' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', - 'description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60000', - ], - ], - 'required' => false, - ], - 'NetTCP' => [ - 'title' => 'TCP拨测的配置参数。当TaskType为2时必填。', - 'description' => 'The parameters of the TCP synthetic test. This parameter is required if the TaskType parameter is set to 2.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'title' => '拨测目标地址（主机）。', - 'description' => 'The IP address of the destination host.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.example.com'."\n", - ], - 'ConnectTimes' => [ - 'title' => '建立TCP连接的次数。最小值为1，最大值为16，默认为4。', - 'description' => 'The number of TCP connections that are established. Minimum value: 1. Maximum value: 16. Default value: 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'Interval' => [ - 'title' => '建立TCP连接的时间间隔。单位为毫秒（ms），最小值为200，最大值为2000，默认为200。', - 'description' => 'The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '200', - ], - 'Timeout' => [ - 'title' => 'TCP拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', - 'description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20000', - ], - 'TracertEnable' => [ - 'title' => '是否开启tracert。默认为true。', - 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TracertNumMax' => [ - 'title' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', - 'description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'TracertTimeout' => [ - 'title' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', - 'description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60000', - ], - ], - 'required' => false, - ], - 'NetDNS' => [ - 'title' => 'DNS拨测的配置参数。当TaskType为3时必填。', - 'description' => 'The parameters of the DNS synthetic test. This parameter is required if the TaskType parameter is set to 3.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'title' => 'DNS拨测的目标地址（域名）。', - 'description' => 'The destination domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.aliyun.com', - ], - 'DnsServerIpType' => [ - 'title' => 'DNS服务器IP类型。0-自动, 1-IPv4，2-IPv6，默认为0。', - 'description' => 'The IP version of the DNS server.'."\n" - ."\n" - .'* 0 (default): IPv4.'."\n" - .'* 1: IPv6.'."\n" - .'* 2: A version is automatically selected.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'NsServer' => [ - 'title' => 'NS服务器IP，默认114.114.114.114。', - 'description' => 'The IP address of the DNS server. Default value: 114.114.114.114.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '114.114.114.114', - ], - 'QueryMethod' => [ - 'title' => 'DNS查询方式，0-递归，1-迭代，默认为0。', - 'description' => 'The DNS query method. Valid values:'."\n" - ."\n" - .'* 0 (default): recursive'."\n" - .'* 1: iterative'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Timeout' => [ - 'title' => 'DNS拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为45000，默认为5000。', - 'description' => 'The timeout period for the DNS synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 45000. Default value: 5000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - ], - 'required' => false, - ], - 'ApiHTTP' => [ - 'description' => 'The parameters of the HTTP(S) synthetic test.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The objects that were returned.'."\n", 'type' => 'object', 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL or request path for synthetic monitoring.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'http://www.demo.com/api/list', - ], - 'Method' => [ - 'description' => 'The request method. Valid values: GET and POST.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'GET', - ], - 'RequestHeaders' => [ - 'description' => 'The HTTP request header.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - 'description' => 'Format: JSON map.'."\n", - ], - ], - 'RequestBody' => [ - 'description' => 'The HTTP request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the request body. Format: JSON string. The parameter is required if the Type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - ], - 'Type' => [ - 'description' => 'The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'application/json', + 'Total' => ['title' => '', 'description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'OnCallSchedules' => [ + 'description' => 'The information about the scheduling policy.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the scheduling policy.'."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => ['title' => '', 'description' => 'The ID of the scheduling policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234'], + 'Name' => ['title' => '', 'description' => 'The name of the scheduling policy.'."\n", 'type' => 'string', 'example' => 'OnCallSchedule_test'], + 'Description' => ['title' => '', 'description' => 'The description of the scheduling policy.'."\n", 'type' => 'string', 'example' => '测试排班策略'], ], + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'ConnectTimeout' => [ - 'description' => 'The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'Timeout' => [ - 'description' => 'The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10000', - ], - 'CheckCert' => [ - 'description' => 'Specifies whether to verify the certificate. Default value: no.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ProtocolAlpnProtocol' => [ - 'description' => 'The ALPN protocol version. You can configure this parameter when you perform an HTTPS synthetic test on a WAP mobile client. Valid values:'."\n" - ."\n" - .'0: default'."\n" - ."\n" - .'1: http/1.1'."\n" - ."\n" - .'2: h2'."\n" - ."\n" - .'3: disables the ALPN protocol'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'Website' => [ - 'description' => 'The parameters of the website speed measurement.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL of the website.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://www.aliyun.com', - ], - 'AutomaticScrolling' => [ - 'description' => 'Specifies whether to automatically scroll up and down the screen to load a page.'."\n" - ."\n" - .'* 0 (default): no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'CustomHeader' => [ - 'description' => 'Specifies whether to create a custom header.'."\n" - ."\n" - .'* 0 (default): No custom header is created.'."\n" - .'* 1: A custom header is created for the first packet.'."\n" - .'* 2: A custom header is created for all packets.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'CustomHeaderContent' => [ - 'description' => 'The custom header. Format: JSON map.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'JSON Map'."\n", - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}'."\n", - ], - ], - 'DisableCache' => [ - 'description' => 'Specifies whether to disable caching.'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1 (default): yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'DisableCompression' => [ - 'description' => 'Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. Valid values: 0: no. 1: yes. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'FilterInvalidIP' => [ - 'description' => 'Specifies whether to exclude invalid IP addresses. Valid values: 0: yes. 1: no. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreCertificateError' => [ - 'description' => 'Specifies whether to ignore certificate errors during certificate verification in the SSL handshake process and continue browsing. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period. Unit: milliseconds. This parameter is optional. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20000', - ], - 'Redirection' => [ - 'description' => 'Specifies whether to continue browsing after redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'SlowElementThreshold' => [ - 'description' => 'The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'WaitCompletionTime' => [ - 'description' => 'The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'VerifyStringBlacklist' => [ - 'description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is in the blacklist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'error', - ], - 'VerifyStringWhitelist' => [ - 'description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is not in the whitelist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success', - ], - 'ElementBlacklist' => [ - 'description' => 'The elements not to be loaded in the page loading process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com/a.jpg', - ], - 'DNSHijackWhitelist' => [ - 'description' => 'If the IP address or CNAME record resolved from a domain name is not included in the DNS whitelist, you cannot access the domain name, or an IP address that belongs to a different domain name is returned. If the IP address or CNAME record is included in the DNS whitelist, DNS hijacking does not occur.'."\n" - ."\n" - .'Format: \\<domain name>:\\<objects>. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - 'PageTamper' => [ - 'description' => 'Elements that are not included in the whitelist and appear on the page are tampered with. These elements can be pop-up ads, floating ads, and page redirection.'."\n" - ."\n" - .'Format: \\<domain name>:\\<elements>. The elements can be wildcard masks. Separate multiple elements with vertical bars (|). Example: www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg. It indicates that all elements that belong to the www.aliyun.com domain name except the basic documents, /cc/bb/a.gif, and /vv/bb/cc.jpg are tampered with.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', - ], - 'FlowHijackJumpTimes' => [ - 'description' => 'The total number of elements on the page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - 'FlowHijackLogo' => [ - 'description' => 'The keyword that is used to identify hijacking. Asterisks (\\*) are allowed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], - ], - 'required' => false, - ], - 'FileDownload' => [ - 'description' => 'The parameters of file downloading.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL that is used to download the file.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png', - ], - 'DownloadKernel' => [ - 'description' => 'The kernel type. Valid values:'."\n" - ."\n" - .'* 1: curl'."\n" - .'* 0: WinInet'."\n" - ."\n" - .'Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'QuickProtocol' => [ - 'description' => 'The QUIC protocol type. Valid values:'."\n" - ."\n" - .'* 1: HTTP/1'."\n" - .'* 2: HTTP/2'."\n" - .'* 3: HTTP/3'."\n" - ."\n" - .'Default value: 1'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'ConnectionTimeout' => [ - 'description' => 'Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60000', - ], - 'CustomHeaderContent' => [ - 'description' => 'The content of the custom request header.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - 'description' => 'Format: JSON map.'."\n", - ], - ], - 'IgnoreCertificateStatusError' => [ - 'description' => 'Specifies whether to ignore certificate status errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'IgnoreCertificateUntrustworthyError' => [ - 'description' => 'Specifies whether to ignore certificate incredibility. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'IgnoreInvalidHostError' => [ - 'description' => 'Specifies whether to ignore host invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Redirection' => [ - 'description' => 'Specifies whether to support redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'TransmissionSize' => [ - 'description' => 'The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2048', - ], - 'IgnoreCertificateCanceledError' => [ - 'description' => 'Specifies whether to ignore certificate revocation errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'IgnoreCertificateAuthError' => [ - 'description' => 'Specifies whether to ignore CA certificate authentication errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'IgnoreCertificateOutOfDateError' => [ - 'description' => 'Specifies whether to ignore certificate invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'IgnoreCertificateUsingError' => [ - 'description' => 'Specifies whether to ignore certificate usage errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'VerifyWay' => [ - 'description' => 'The verification method. Valid values:'."\n" - ."\n" - .'* 0: no verification'."\n" - .'* 1: string verification'."\n" - .'* 2: MD5 verification'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'ValidateKeywords' => [ - 'description' => 'The keyword that is used in verification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], - 'WhiteList' => [ - 'description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - ], - 'required' => false, - ], - 'Stream' => [ - 'description' => 'The parameters of the streaming-media synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The resource URL of the streaming media.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com/stream/test.mp4'."\n", - ], - 'StreamType' => [ - 'description' => 'Specifies whether the resource is a video or audio. Valid values: 0: video. 1: audio.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'StreamMonitorTimeout' => [ - 'description' => 'The monitoring duration. Unit: seconds. Maximum and default value: 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'StreamAddressType' => [ - 'description' => 'The address type of the resource. Valid values:'."\n" - ."\n" - .'* 1: resource URL'."\n" - .'* 0 (default): page URL'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'PlayerType' => [ - 'description' => 'The player. Default value: 12. Valid values:'."\n" - ."\n" - .'* 12: VLC'."\n" - .'* 2: Flash Player'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '12', - ], - 'CustomHeaderContent' => [ - 'description' => 'The custom header. Format: JSON map.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}'."\n", - 'description' => 'The custom header. Format: JSON map.'."\n", - ], - ], - 'WhiteList' => [ - 'description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'example' => '', ], ], - 'required' => true, + 'example' => '', ], ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"OnCallSchedules\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"OnCallSchedule_test\\",\\n \\"Description\\": \\"测试排班策略\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListOnCallSchedules', + 'changeSet' => [ + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOnCallSchedules'], + ], + ], + 'ramActions' => [], + ], + 'ListPrometheusAlertRules' => [ + 'summary' => 'Queries the alert rules created for a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'MonitorCategory', - 'in' => 'query', - 'schema' => [ - 'description' => 'The detection point type. Valid values:'."\n" - ."\n" - .'- 1: PC'."\n" - .'- 2: mobile device', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list'], + 'parameters' => [ [ - 'name' => 'Monitors', + 'name' => 'Name', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of detection points.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CityCode' => [ - 'description' => 'The city code.', - 'type' => 'string', - 'required' => true, - 'example' => '100023', - ], - 'OperatorCode' => [ - 'description' => 'The carrier code.', - 'type' => 'string', - 'required' => true, - 'example' => '1', - ], - 'ClientType' => [ - 'description' => 'The client type of the detection point. Valid values:'."\n" - ."\n" - .'- 1: data center'."\n" - .'- 2: Internet'."\n" - .'- 3: mobile device'."\n" - .'- 4: ECS instance', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - ], - 'required' => true, - ], - 'required' => true, - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'Prometheus_Alert', 'title' => ''], ], [ - 'name' => 'Frequency', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.', - 'type' => 'string', - 'required' => true, - 'example' => '5m', - ], + 'schema' => ['description' => 'The region ID of the instance.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'CustomPeriod', + 'name' => 'ClusterId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The general settings.', - 'type' => 'object', - 'properties' => [ - 'EndHour' => [ - 'description' => 'The custom host settings.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '22', - ], - 'StartHour' => [ - 'description' => 'The list of hosts.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '8', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], ], [ - 'name' => 'CommonSetting', + 'name' => 'Type', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The general settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomHost' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Hosts' => [ - 'description' => 'The list of hosts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'www.aliyun.com', - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4.'."\n" - .'* 2: IPv6.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - 'Ips' => [ - 'description' => 'The list of IP addresses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '10.176.141.63', - ], - 'required' => true, - ], - ], - 'required' => true, - ], - 'required' => true, - ], - 'SelectType' => [ - 'description' => 'The selection mode. Valid values:'."\n" - ."\n" - .'* 0: random'."\n" - .'* 1: polling'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4.'."\n" - .'* 2: IPv6.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'MonitorSamples' => [ - 'description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IsOpenTrace' => [ - 'description' => 'Specifies whether to enable tracing.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TraceClientType' => [ - 'description' => 'The type of the client for tracing. Valid values:'."\n" - ."\n" - .'* 0: ARMS agent'."\n" - .'* 1: OpenTelemetry'."\n" - .'* 2: Jaeger'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'XtraceRegion' => [ - 'description' => 'The region to which trace data is reported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'CustomVPCSetting' => [ - 'description' => 'The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'VpcId' => [ - 'description' => 'VPC ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp1muectbr8f90vjxxxxx', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-bp14crq29vpycxp8xxxxx', - ], - 'SecureGroupId' => [ - 'description' => 'The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-bp13wzf9vuwegmpxxxxx', - ], - ], - 'required' => false, - ], - 'CustomPrometheusSetting' => [ - 'description' => 'The reserved parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'PrometheusLabels' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'A reserved parameter.'."\n", - 'example' => 'null', - ], - ], - 'PrometheusClusterId' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'PrometheusClusterRegion' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The type of the alert rule.', 'type' => 'string', 'required' => false, 'example' => '自定义', 'title' => ''], ], [ - 'name' => 'AvailableAssertions', + 'name' => 'Status', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of assertions.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.', - 'type' => 'string', - 'required' => true, - 'example' => 'DnsARecord', - ], - 'Target' => [ - 'description' => 'The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.', - 'type' => 'string', - 'required' => false, - 'example' => 'key', - ], - 'Operator' => [ - 'description' => 'The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.', - 'type' => 'string', - 'required' => true, - 'example' => 'eq', - ], - 'Expect' => [ - 'description' => 'The expected value.', - 'type' => 'string', - 'required' => true, - 'example' => '200', - ], - ], - 'required' => true, - ], - 'required' => false, - ], + 'schema' => ['description' => 'Specifies whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- 1: enables the alert rule.'."\n" + .'- 0: disables the alert rule.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'MatchExpressions', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameter is optional.', - 'type' => 'string', - 'required' => false, - 'example' => 'xxxx', - ], + 'schema' => ['description' => 'The tag match conditions that are described in a JSON string. For more information about this parameter, see the **Additional description of the MatchExpressions parameter** section.', 'type' => 'string', 'required' => false, 'example' => '[{"key":"severity","value":"critical","operator":"re"}]', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tag list.', + 'description' => 'The tags.'."\n", 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The tag.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => 'Key', - ], - 'Value' => [ - 'description' => 'The value of the tag.', - 'type' => 'string', - 'required' => false, - 'example' => '500', - ], + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'owner', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zhangsan', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '53B5874D-EBC1-5567-B787-E4B7267F5CEB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned. The status code 200 indicates that the request was successful.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.', - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The struct returned.', - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the synthetic monitoring task.', - 'type' => 'string', - 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', - ], - 'Status' => [ - 'description' => 'The task status. Valid values:'."\n" + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', 'title' => ''], + 'PrometheusAlertRules' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Status' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" ."\n" - .'- INIT: The task is in the initial state.'."\n" - .'- RELEASE: The task is being parsed.'."\n" - .'- RUNNING: The task is running.'."\n" - .'- STOP: The task is suspended.'."\n" - .'- SYSTEM_STOP: The task is suspended by the system.'."\n" - .'- CANCEL: The task is canceled.'."\n" - .'- SYSTEM_CANCEL: The task is canceled by the system.'."\n" - .'- DONE: The task is complete.', - 'type' => 'string', - 'example' => 'RUNNING', + .'- 1: The alert rule is enabled.'."\n" + .'- 0: The alert rule is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The type of the alert rule.', 'type' => 'string', 'example' => '自定义', 'title' => ''], + 'NotifyType' => ['description' => 'The method that is used to send alert notifications. Valid values:'."\n" + ."\n" + .'- ALERT_MANAGER: Alert notifications are sent by Operation Center.'."\n" + .'- DISPATCH_RULE: Alert notifications are', 'type' => 'string', 'example' => 'ALERT_MANAGER', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.', 'type' => 'string', 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', 'title' => ''], + 'Message' => ['description' => 'The alert message. Tags can be referenced in the {{$labels.xxx}} format.', 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + 'Duration' => ['description' => 'The duration of the alert. Valid values: 1 to 1440. Unit: minutes.', 'type' => 'string', 'example' => '1m', 'title' => ''], + 'DispatchRuleId' => ['description' => 'The ID of the notification policy. This parameter is returned if the NotifyType parameter is set to `DISPATCH_RULE`.', 'type' => 'integer', 'format' => 'int64', 'example' => '10282', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'Prometheus_Alert', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '3888704', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags of the alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag of the alert rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => 'severity', 'title' => ''], + 'Value' => ['description' => 'The value of the tag associated with the instance.', 'type' => 'string', 'example' => 'critical', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Annotations' => [ + 'description' => 'The annotations of the alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The annotation of the alert rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the annotation.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Value' => ['description' => 'The value of the annotation.', 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', - ], - [ - 'errorCode' => 'INNER_PROHIBIT', - 'errorMessage' => '内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"53B5874D-EBC1-5567-B787-E4B7267F5CEB\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"5308a2691f59422c8c3b7aeccec9cd3b\\",\\n \\"Status\\": \\"RUNNING\\"\\n }\\n}","type":"json"}]', - 'title' => 'CreateTimingSyntheticTask', - 'requestParamsDescription' => 'Assertion description:'."\n" - ."\n" - .'### HTTP synthetic tests'."\n" - ."\n" - .'If the type parameter is set to HttpResCode, the Operator parameter supports the following values: eq, neq, gt, gte, lt, lte, belong, and n_belong.'."\n" - .'If the type parameter is set to HttpResHead, the Operator parameter supports all values.'."\n" - .'If the type parameter is set to HttpResBody, the Operator parameter supports all values.'."\n" - .'If the type parameter is set to HttpResBodyJson, the Operator parameter supports all values.'."\n" - .'If the type parameter is set to HttpResponseTime, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'### ICMP synthetic tests'."\n" - ."\n" - .'If the type parameter is set to IcmpPackLoss, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to IcmpPackMaxLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to IcmpPackAvgLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to TraceRouteHops, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'### DNS synthetic tests'."\n" - ."\n" - .'If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.'."\n" - .'If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.'."\n" - .'### Website speed measurement'."\n" + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRules\\": [\\n {\\n \\"Status\\": 1,\\n \\"Type\\": \\"自定义\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"1m\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListPrometheusAlertRules', + 'requestParamsDescription' => '### Additional description of the MatchExpressions parameter'."\n" + .'JSON string example and description'."\n" ."\n" - .'If the type parameter is set to websiteTTFB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to websiteTTLB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to websiteFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to websiteFFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - .'If the type parameter is set to websiteOnload, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.', - ], - 'UpdateTimingSyntheticTask' => [ - 'summary' => 'Updates a scheduled synthetic test task.', - 'methods' => [ - 'post', + .'```'."\n" + .'['."\n" + .'{'."\n" + .' "key":"severity", // The key of the tag. '."\n" + .' "value":"critical", // The value of the tag. '."\n" + .' "operator":"re" // eq: equals to. re: matches a regular expression. '."\n" + .'}'."\n" + .']'."\n" + .'```', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-31T01:50:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-11T12:16:04.000Z', 'description' => 'Request parameters changed, Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusAlertRules'], + ], ], + 'ramActions' => [], + ], + 'ListPrometheusAlertTemplates' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'TaskId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5308a2691f59422c8c3b7aeccxxxxxxx', - ], + 'schema' => ['description' => 'The ID of the cluster.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], ], [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AlibabaCloud DNS Task', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], - [ - 'name' => 'MonitorConf', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The monitoring configurations.'."\n", 'type' => 'object', 'properties' => [ - 'NetICMP' => [ - 'description' => 'The parameters of the ICMP synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The IP address or domain name of the destination host. The value cannot contain port numbers, protocol headers, or request paths.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - ], - 'Interval' => [ - 'description' => 'The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 10000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - 'PackageNum' => [ - 'description' => 'The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'PackageSize' => [ - 'description' => 'The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024, 1080, and 1450.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '32', - ], - 'SplitPackage' => [ - 'description' => 'Specifies whether to split ICMP packets. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true'."\n", - ], - 'Timeout' => [ - 'description' => 'The timeout period for the ICMP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'TracertEnable' => [ - 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TracertNumMax' => [ - 'description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'TracertTimeout' => [ - 'description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60000', - ], - ], - 'required' => false, - ], - 'NetTCP' => [ - 'description' => 'The parameters of the TCP synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The IP address of the destination host.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1:8888', - ], - 'ConnectTimes' => [ - 'description' => 'The number of TCP connections that are established. Minimum value: 1. Maximum value: 16. Default value: 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - 'Interval' => [ - 'description' => 'The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], - 'Timeout' => [ - 'description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - 'TracertEnable' => [ - 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TracertNumMax' => [ - 'description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], - 'TracertTimeout' => [ - 'description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - ], - 'required' => false, - ], - 'NetDNS' => [ - 'description' => 'The parameters of the DNS synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - ], - 'Dig' => [ - 'description' => 'Specifies whether to use the dig command to display the data. Valid values: 0: no. 1: yes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'DnsServerIpType' => [ - 'description' => 'The IP version of the DNS server. Valid values: 0: IPv4. 1: IPv6. 2: A version is automatically selected. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'NsServer' => [ - 'description' => 'The IP address of the DNS server. Default value: 114.114.114.114.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '114.114.114.114', - ], - 'QueryMethod' => [ - 'description' => 'The DNS query method. Valid values: 0: recursive. 1: iterative. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Timeout' => [ - 'description' => 'The timeout period for the DNS synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 45000. Default value: 5000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1000', - ], - ], - 'required' => false, - ], - 'ApiHTTP' => [ - 'description' => 'The parameters of the HTTP(S) synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL or request path for synthetic monitoring.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://********', - ], - 'Method' => [ - 'description' => 'The request method. Valid values:'."\n" - ."\n" - .'* POST'."\n" - .'* GET'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POST', - ], - 'RequestHeaders' => [ - 'description' => 'The custom header field.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - 'description' => 'The HTTP request header.'."\n", - ], - ], - 'RequestBody' => [ - 'description' => 'The HTTP request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the request body. Format: JSON string. The parameter is required if the Type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - ], - 'Type' => [ - 'description' => 'The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'application/json', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', 'title' => ''], + 'PrometheusAlertTemplates' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the alert rule.'."\n", 'type' => 'string', 'example' => '节点', 'title' => ''], + 'Description' => ['description' => 'The content of the alert notification. Tags can be referenced in the {{$labels.xxx}} format.'."\n", 'type' => 'string', 'example' => '节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.'."\n", 'type' => 'string', 'example' => 'node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10', 'title' => ''], + 'Version' => ['description' => 'The version of the alert rule.'."\n", 'type' => 'string', 'example' => '1.0', 'title' => ''], + 'Duration' => ['description' => 'The duration of the alert. Valid values: 1 to 1440. Unit: minutes.'."\n", 'type' => 'string', 'example' => '1m', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'example' => '节点内存可用率不足10%', 'title' => ''], + 'Labels' => [ + 'description' => 'The tags of the alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the tag.'."\n", 'type' => 'string', 'example' => 'severity', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'example' => 'warning', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'ConnectTimeout' => [ - 'description' => 'The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'Timeout' => [ - 'description' => 'The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'CheckCert' => [ - 'description' => 'Specifies whether to verify the certificate. Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'ProtocolAlpnProtocol' => [ - 'description' => 'The ALPN protocol version. You can configure this parameter when you perform an HTTPS synthetic test on a WAP mobile client. Valid values:'."\n" - ."\n" - .'0: default'."\n" - ."\n" - .'1-http/1.1'."\n" - ."\n" - .'2-h2'."\n" - ."\n" - .'3: disables the ALPN protocol'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'Website' => [ - 'description' => 'The parameters of the website speed measurement.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL of the website.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://********', - ], - 'AutomaticScrolling' => [ - 'description' => 'Specifies whether to automatically scroll up and down the screen to load a page. Valid values: 0: no. 1: yes. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'CustomHeader' => [ - 'description' => 'Specifies whether to create a custom header. Valid values: 0: no. 1: The first packet is modified. 2: All packets are modified. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'CustomHeaderContent' => [ - 'description' => 'The custom header. Format: JSON map.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The custom header. Format: JSON map.'."\n", - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - ], - ], - 'DisableCache' => [ - 'description' => 'Specifies whether to disable the cache. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'DisableCompression' => [ - 'description' => 'Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. Valid values: 0: no. 1: yes. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'FilterInvalidIP' => [ - 'description' => 'Specifies whether to exclude invalid IP addresses. Valid values:'."\n" - ."\n" - .'* 1: no'."\n" - .'* 0: yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreCertificateError' => [ - 'description' => 'Specifies whether to ignore SSL certificate errors during browsing. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 5000. Maximum value: 300000. Default value: 40000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20000', - ], - 'Redirection' => [ - 'description' => 'Specifies whether to continue browsing after redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'SlowElementThreshold' => [ - 'description' => 'The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'WaitCompletionTime' => [ - 'description' => 'The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'VerifyStringBlacklist' => [ - 'description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is in the blacklist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'error', - ], - 'VerifyStringWhitelist' => [ - 'description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is not in the whitelist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'success', - ], - 'ElementBlacklist' => [ - 'description' => 'The elements not to be loaded in the page loading process.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'a.jpg', - ], - 'DNSHijackWhitelist' => [ - 'description' => 'If the IP address or CNAME record resolved from a domain name is not included in the DNS whitelist, you cannot access the domain name, or an IP address that belongs to a different domain name is returned. If the IP address or CNAME record is included in the DNS whitelist, DNS hijacking does not occur.'."\n" - ."\n" - .'Format: \\<domain name>:\\<objects>. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - 'PageTamper' => [ - 'description' => 'Elements that are not included in the whitelist and appear on the page are manipulated. These elements can be pop-up ads, floating ads, and page redirection.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', - ], - 'FlowHijackJumpTimes' => [ - 'description' => 'The total number of elements on the page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'FlowHijackLogo' => [ - 'description' => 'The keyword that is used to identify hijacking. Asterisks (\\*) are allowed.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], - ], - 'required' => false, - ], - 'FileDownload' => [ - 'description' => 'The parameters of file downloading.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL that is used to download the file.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png', - ], - 'DownloadKernel' => [ - 'description' => 'The kernel type. Valid values:'."\n" - ."\n" - .'* 1: curl'."\n" - .'* 0: WinInet'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'QuickProtocol' => [ - 'description' => 'The QUIC protocol type. Valid values:'."\n" - ."\n" - .'* 1: HTTP/1'."\n" - .'* 2: HTTP/2'."\n" - .'* 3: http3'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'ConnectionTimeout' => [ - 'description' => 'Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5000', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60000', - ], - 'CustomHeaderContent' => [ - 'description' => 'The content of the custom request header. Format: JSON map.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - 'description' => 'The content of the custom request header. Format: JSON map.'."\n", - ], - ], - 'IgnoreCertificateStatusError' => [ - 'description' => 'Specifies whether to ignore certificate status errors. 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreCertificateUntrustworthyError' => [ - 'description' => 'Specifies whether to ignore certificate incredibility. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreInvalidHostError' => [ - 'description' => 'Specifies whether to ignore host invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Redirection' => [ - 'description' => 'Specifies whether to support redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'TransmissionSize' => [ - 'description' => 'The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2048', - ], - 'IgnoreCertificateCanceledError' => [ - 'description' => 'Specifies whether to ignore certificate revocation errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreCertificateAuthError' => [ - 'description' => 'Specifies whether to ignore CA certificate authentication errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreCertificateOutOfDateError' => [ - 'description' => 'Specifies whether to ignore certificate invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IgnoreCertificateUsingError' => [ - 'description' => 'Specifies whether to ignore certificate usage errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'VerifyWay' => [ - 'description' => 'The verification method. Valid values:'."\n" - ."\n" - .'* 0: no verification'."\n" - .'* 1: string verification'."\n" - .'* 2: MD5 verification'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'ValidateKeywords' => [ - 'description' => 'The keyword that is used in verification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'aliyun', - ], - 'WhiteList' => [ - 'description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - ], - 'required' => false, - ], - 'Stream' => [ - 'description' => 'The parameters of the streaming-media synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The resource URL of the streaming media.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://www.aliyun.com/stream/test.mp4', - ], - 'StreamType' => [ - 'description' => 'Specifies whether the resource is a video or audio. Valid values: 0: video. 1: audio.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'StreamMonitorTimeout' => [ - 'description' => 'The monitoring duration. Unit: seconds. Maximum and default value: 60.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '30', - ], - 'StreamAddressType' => [ - 'description' => 'The address type of the resource. Valid values:'."\n" - ."\n" - .'* 1: resource URL.'."\n" - .'* 0: page URL. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PlayerType' => [ - 'description' => 'The player. Default value: 12. Valid values:'."\n" - ."\n" - .'* 12: VLC'."\n" - .'* 2: Flash Player'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '2', - ], - 'CustomHeaderContent' => [ - 'description' => 'The custom header. Format: JSON map.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - 'description' => 'The custom header. Format: JSON map.'."\n", + 'Annotations' => [ + 'description' => 'The annotations of the alert rule.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => ['description' => 'The name of the annotation.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Value' => ['description' => 'The value of the annotation.'."\n", 'type' => 'string', 'example' => '节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], - 'WhiteList' => [ - 'description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Monitors', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of monitoring points.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'CityCode' => [ - 'description' => 'The city code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '100001', - ], - 'OperatorCode' => [ - 'description' => 'The carrier code.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'ClientType' => [ - 'description' => 'The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '4', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertTemplates\\": [\\n {\\n \\"Type\\": \\"节点\\",\\n \\"Description\\": \\"节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%\\",\\n \\"Expression\\": \\"node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Duration\\": \\"1m\\",\\n \\"AlertName\\": \\"节点内存可用率不足10%\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"warning\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'ListPrometheusAlertTemplates', + 'summary' => 'Queries the alert templates of Prometheus Service.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T06:25:24.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusAlertTemplates'], ], + ], + 'ramActions' => [], + ], + 'ListPrometheusGlobalView' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Frequency', - 'in' => 'query', - 'schema' => [ - 'description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5m', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'CustomPeriod', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The custom cycle.'."\n", 'type' => 'object', 'properties' => [ - 'EndHour' => [ - 'description' => 'The hour at which the test ends. Valid values: 0 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '22', - ], - 'StartHour' => [ - 'description' => 'The hour at which the test starts. Valid values: 0 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '14', - ], + 'Data' => ['description' => 'The list of global aggregation instances. The value of this parameter is a string in the JSON format.'."\n", 'type' => 'string', 'example' => '[ {groupName: "聚合实例名称", clusterId: "global-v2-clusterid", endpoint: "cn-hangzhou"}, // ..... more items ]', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'DBDCE95A-A0DD-5FC5-97CC-EEFC3D814385', 'title' => ''], + 'Code' => ['description' => 'Status code. Description 200 means success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'More information.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'title' => 'ListPrometheusGlobalView', + 'summary' => 'Creates a global aggregation instance in Prometheus Service and obtains the list of global aggregation instances.', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusGlobalView'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[ {groupName: \\\\\\"聚合实例名称\\\\\\", clusterId: \\\\\\"global-v2-clusterid\\\\\\", endpoint: \\\\\\"cn-hangzhou\\\\\\"}, // ..... more items ]\\",\\n \\"RequestId\\": \\"DBDCE95A-A0DD-5FC5-97CC-EEFC3D814385\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'ListPrometheusInstanceByTagAndResourceGroupId' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'CommonSetting', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The general settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomHost' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Hosts' => [ - 'description' => 'The list of hosts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com', - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4'."\n" - .'* 2: IPv6'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'Ips' => [ - 'description' => 'The list of IP addresses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '127.0.0.1', - ], - 'required' => false, - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'SelectType' => [ - 'description' => 'The selection mode. Valid values:'."\n" - ."\n" - .'* 0: random'."\n" - .'* 1: polling'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4'."\n" - .'* 2: IPv6'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'MonitorSamples' => [ - 'description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '0', - ], - 'IsOpenTrace' => [ - 'description' => 'Specifies whether to enable tracing.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - 'TraceClientType' => [ - 'description' => 'The type of the client for tracing. Valid values:'."\n" - ."\n" - .'* 0: ARMS agent'."\n" - .'* 1: OpenTelemetry'."\n" - .'* 2: Jaeger'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'XtraceRegion' => [ - 'description' => 'The region to which trace data is reported.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'CustomVPCSetting' => [ - 'description' => 'The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'VpcId' => [ - 'description' => 'VPC ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vpc-bp15bjtubjytclwxxxxxx', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'vsw-2zevek6r3mpny7wxxxxxv', - ], - 'SecureGroupId' => [ - 'description' => 'The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'sg-xxxxxxxx', - ], - ], - 'required' => false, - ], - 'CustomPrometheusSetting' => [ - 'description' => 'The reserved parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'PrometheusLabels' => [ - 'description' => 'The reserved parameters.'."\n", - 'type' => 'object', - 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'The reserved parameters.'."\n", - 'example' => 'A reserved parameter.', - ], - ], - 'PrometheusClusterId' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'A reserved parameter.', - ], - 'PrometheusClusterRegion' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'A reserved parameter.', - ], - ], - 'required' => false, - ], - ], - 'required' => false, - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AvailableAssertions', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of assertions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TraceRouteHops', - ], - 'Target' => [ - 'description' => 'The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'HttpResponseTime', - ], - 'Operator' => [ - 'description' => 'The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eq'."\n", - ], - 'Expect' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '200', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The region ID of the Prometheus instance.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The ID of the resource group.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'Tag', 'in' => 'query', - 'style' => 'json', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of tags.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => '', + 'description' => 'The tag of the resource.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'key'."\n", - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value', - ], + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'fpx-tag', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'fvt-tag-value', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - '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. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'Id of the request', 'type' => 'string', 'title' => '', 'example' => '4789C3E9-A85A-524B-B97B-9D2B14BA06BC'], 'Data' => [ - 'description' => 'The struct returned.'."\n", + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'example' => '1eeb351722c84e05b52c82fd0dc9953e', + 'PrometheusInstances' => [ + 'description' => 'The queried Prometheus instances.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'example' => 'c9d5dda1aeca64220853ace304baeb03d', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-shanghai', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.', 'type' => 'string', 'example' => '1672753017899***', 'title' => ''], + 'ClusterName' => ['description' => 'The name of the Prometheus instance.', 'type' => 'string', 'example' => 'prom1', 'title' => ''], + 'ClusterType' => ['description' => 'The instance type. Valid values:'."\n" + ."\n" + .'- remote-write: Prometheus instance for Remote Write'."\n" + ."\n" + .'- ecs: Prometheus instances for ECS'."\n" + ."\n" + .'- cloud-monitor: Prometheus instance for Alibaba Cloud services in the Chinese mainland'."\n" + ."\n" + .'- cloud-product: Prometheus instance for Alibaba Cloud services outside the Chinese mainland'."\n" + ."\n" + .'- global-view: global aggregation instance'."\n" + ."\n" + .'- aliyun-cs: Prometheus instance for Container Service', 'type' => 'string', 'title' => '', 'example' => 'ecs'], + 'VpcId' => ['description' => 'The ID of the virtual private cloud (VPC).', 'type' => 'string', 'example' => 'vpc-8vbtp1fsm8mir18l8rl0u', 'title' => ''], + 'VSwitchId' => ['description' => 'The ID of the vSwitch.', 'type' => 'string', 'example' => 'vsw-f8z73vcja1tqnw90aav5a', 'title' => ''], + 'SecurityGroupId' => ['description' => 'The ID of the security group.', 'type' => 'string', 'example' => 'sg-f8zd1toc10wmbi1v5rom', 'title' => ''], + 'SubClustersJson' => ['description' => 'The child instances of the global aggregation instance. The value is a JSON string.', 'type' => 'string', 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "headers": {},'."\n" + .' "regionId": "cn-hangzhou",'."\n" + .' "sourceType": "AlibabaPrometheus",'."\n" + .' "extras": {},'."\n" + .' "clusterId": "c39a1048921e04fceb039db2fb****",'."\n" + .' "sourceName": "arms-luyao-test",'."\n" + .' "dataSource": "",'."\n" + .' "userId": "167275301789****"'."\n" + .' },'."\n" + .' {'."\n" + .' "headers": {},'."\n" + .' "regionId": "cn-beijing",'."\n" + .' "sourceType": "AlibabaPrometheus",'."\n" + .' "extras": {},'."\n" + .' "clusterId": "c6b6485496d5b400abde22cb47b5****",'."\n" + .' "sourceName": "agent-321-测试",'."\n" + .' "dataSource": "",'."\n" + .' "userId": "167275301789****"'."\n" + .' },'."\n" + .' {'."\n" + .' "headers": {},'."\n" + .' "regionId": "cn-zhangjiakou",'."\n" + .' "sourceType": "AlibabaPrometheus",'."\n" + .' "extras": {},'."\n" + .' "clusterId": "c261a4f3200c446659133f1ade78****",'."\n" + .' "sourceName": "zaifeng-cardinality-01",'."\n" + .' "dataSource": "",'."\n" + .' "userId": "167275301789****"'."\n" + .' }'."\n" + .']'], + 'RemoteReadIntraUrl' => ['description' => 'The internal URL for remote read.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', 'title' => ''], + 'RemoteReadInterUrl' => ['description' => 'The public URL for remote read.', 'type' => 'string', 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', 'title' => ''], + 'RemoteWriteIntraUrl' => ['description' => 'The internal URL for remote write.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write', 'title' => ''], + 'RemoteWriteInterUrl' => ['description' => 'The public URL for remote write.', 'type' => 'string', 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write', 'title' => ''], + 'PushGatewayIntraUrl' => ['description' => 'The internal URL for Pushgateway.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2', 'title' => ''], + 'PushGatewayInterUrl' => ['description' => 'The public URL for Pushgateway.', 'type' => 'string', 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2', 'title' => ''], + 'HttpApiIntraUrl' => ['description' => 'The internal URL for the HTTP API.', 'type' => 'string', 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx'."\n", 'title' => ''], + 'HttpApiInterUrl' => ['description' => 'The public URL for the HTTP API.', 'type' => 'string', 'example' => 'https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx', 'title' => ''], + 'AuthToken' => ['description' => 'The authorization token.', 'type' => 'string', 'example' => 'GciOiJIUzI1NiJ9***', 'title' => ''], + 'PaymentType' => ['description' => 'The billing method. Valid values:'."\n" + ."\n" + .'- PREPAY: subscription'."\n" + ."\n" + .'- POSTPAY: pay-as-you-go', 'type' => 'string', 'example' => 'POSTPAY', 'title' => ''], + 'GrafanaInstanceId' => ['description' => 'The ID of the Grafana workspace.', 'type' => 'string', 'example' => 'grafana-rnggfvhlcdl6m71l**', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group to which the Prometheus instance belongs.', 'type' => 'string', 'example' => 'rg-acfmz7nocpeidcy', 'title' => ''], + 'ResourceType' => ['description' => 'The resource type.', 'type' => 'string', 'example' => 'PROMETHEUS', 'title' => ''], + 'Tags' => [ + 'description' => 'The list of tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'The tag.', + 'type' => 'object', + 'properties' => [ + 'TagKey' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'ac-cus-tag-3', 'title' => ''], + 'TagValue' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'asg-2vc8qq7x89o11rus9uvu', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], + 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'INNER_PROHIBIT', - 'errorMessage' => '内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙', - ], - ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'ListPrometheusInstanceByTagAndResourceGroupId', + 'summary' => 'Queries Prometheus instances by tag and resource group.', + 'changeSet' => [ + ['createdAt' => '2023-12-13T03:33:51.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-06-21T07:11:06.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-17T09:14:49.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-30T09:15:10.000Z', 'description' => 'Response parameters changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstanceByTagAndResourceGroupId'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"1eeb351722c84e05b52c82fd0dc9953e\\"\\n }\\n}","type":"json"}]', - 'title' => 'UpdateTimingSyntheticTask', - 'requestParamsDescription' => 'Assertion description:'."\n" - ."\n" - .'HTTP synthetic tests:'."\n" - ."\n" - .'● If the type parameter is set to HttpResCode, the Operator parameter supports the following values: eq, neq, gt, gte, lt, lte, belong, and n_belong.'."\n" - ."\n" - .'● If the type parameter is set to HttpResHead, the Operator parameter supports all values.'."\n" - ."\n" - .'● If the type parameter is set to HttpResBody, the Operator parameter supports all values.'."\n" - ."\n" - .'● If the type parameter is set to HttpResBodyJson, the Operator parameter supports all values.'."\n" - ."\n" - .'● If the type parameter is set to HttpResponseTime, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'ICMP synthetic tests:'."\n" - ."\n" - .'● If the type parameter is set to IcmpPackLoss, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to IcmpPackMaxLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to IcmpPackAvgLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to TraceRouteHops, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'DNS synthetic tests:'."\n" - ."\n" - .'● If the type parameter is set to DnsARecord, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. A records can be selectively displayed.'."\n" - ."\n" - .'● If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.'."\n" - ."\n" - .'Website speed measurement:'."\n" - ."\n" - .'● If the type parameter is set to websiteTTFB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to websiteTTLB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to websiteFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to websiteFFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" - ."\n" - .'● If the type parameter is set to websiteOnload, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n", + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4789C3E9-A85A-524B-B97B-9D2B14BA06BC\\",\\n \\"Data\\": {\\n \\"PrometheusInstances\\": [\\n {\\n \\"ClusterId\\": \\"c9d5dda1aeca64220853ace304baeb03d\\",\\n \\"RegionId\\": \\"cn-shanghai\\",\\n \\"UserId\\": \\"1672753017899***\\",\\n \\"ClusterName\\": \\"prom1\\",\\n \\"ClusterType\\": \\"ecs\\",\\n \\"VpcId\\": \\"vpc-8vbtp1fsm8mir18l8rl0u\\",\\n \\"VSwitchId\\": \\"vsw-f8z73vcja1tqnw90aav5a\\",\\n \\"SecurityGroupId\\": \\"sg-f8zd1toc10wmbi1v5rom\\",\\n \\"SubClustersJson\\": \\"[\\\\n {\\\\n \\\\\\"headers\\\\\\": {},\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-hangzhou\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"AlibabaPrometheus\\\\\\",\\\\n \\\\\\"extras\\\\\\": {},\\\\n \\\\\\"clusterId\\\\\\": \\\\\\"c39a1048921e04fceb039db2fb****\\\\\\",\\\\n \\\\\\"sourceName\\\\\\": \\\\\\"arms-luyao-test\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"167275301789****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"headers\\\\\\": {},\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-beijing\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"AlibabaPrometheus\\\\\\",\\\\n \\\\\\"extras\\\\\\": {},\\\\n \\\\\\"clusterId\\\\\\": \\\\\\"c6b6485496d5b400abde22cb47b5****\\\\\\",\\\\n \\\\\\"sourceName\\\\\\": \\\\\\"agent-321-测试\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"167275301789****\\\\\\"\\\\n },\\\\n {\\\\n \\\\\\"headers\\\\\\": {},\\\\n \\\\\\"regionId\\\\\\": \\\\\\"cn-zhangjiakou\\\\\\",\\\\n \\\\\\"sourceType\\\\\\": \\\\\\"AlibabaPrometheus\\\\\\",\\\\n \\\\\\"extras\\\\\\": {},\\\\n \\\\\\"clusterId\\\\\\": \\\\\\"c261a4f3200c446659133f1ade78****\\\\\\",\\\\n \\\\\\"sourceName\\\\\\": \\\\\\"zaifeng-cardinality-01\\\\\\",\\\\n \\\\\\"dataSource\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"userId\\\\\\": \\\\\\"167275301789****\\\\\\"\\\\n }\\\\n]\\",\\n \\"RemoteReadIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteReadInterUrl\\": \\"http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read\\",\\n \\"RemoteWriteIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"RemoteWriteInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write\\",\\n \\"PushGatewayIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"PushGatewayInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2\\",\\n \\"HttpApiIntraUrl\\": \\"http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx\\\\n\\",\\n \\"HttpApiInterUrl\\": \\"https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx\\",\\n \\"AuthToken\\": \\"GciOiJIUzI1NiJ9***\\",\\n \\"PaymentType\\": \\"POSTPAY\\",\\n \\"GrafanaInstanceId\\": \\"grafana-rnggfvhlcdl6m71l**\\",\\n \\"ResourceGroupId\\": \\"rg-acfmz7nocpeidcy\\",\\n \\"ResourceType\\": \\"PROMETHEUS\\",\\n \\"Tags\\": [\\n {\\n \\"TagKey\\": \\"ac-cus-tag-3\\",\\n \\"TagValue\\": \\"asg-2vc8qq7x89o11rus9uvu\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', ], - 'StopTimingSyntheticTask' => [ - 'summary' => 'Stops scheduled synthetic monitoring tasks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPrometheusInstances' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'description' => 'The cluster type. If you do not specify this parameter, all cluster types are queried. Valid values:'."\n" + ."\n" + .'- cloud-product-prometheus: Prometheus instance for cloud services'."\n" + ."\n" + .'- ManagedKubernetes: ACK managed cluster'."\n" + ."\n" + .'- satellite: Prometheus instance for ARMS OpenTelemetry'."\n" + ."\n" + .'- Ask: ACK Serverless cluster'."\n" + ."\n" + .'- remote-write-prometheus: general-purpose Prometheus instance'."\n" + ."\n" + .'- cloud-monitor-cmee: Hybrid Cloud Monitoring'."\n" + ."\n" + .'- ExternalKubernetes: external Kubernetes cluster registered in ACK'."\n" + ."\n" + .'- vpc-prometheus: Prometheus instance for ECS'."\n" + ."\n" + .'- cloud-monitor-direct: cloud service self-monitoring'."\n" + ."\n" + .'- Edge Kubernetes: ACK Edge cluster', + 'enumValueTitles' => [], 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'docRequired' => false, + 'example' => 'cloud-product-prometheus', + 'title' => '', ], ], [ - 'name' => 'TaskIds', + 'name' => 'ShowGlobalView', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The task IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3cee3d23ev4342342csc', - ], - 'required' => true, - ], + 'schema' => ['description' => 'Specifies whether to obtain global aggregation instances. Valid values:'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'description' => 'The information about the array object.', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'Data' => ['description' => 'The Prometheus instances in the region in the JSON format.', 'type' => 'string', 'example' => '[{"agentStatus":"0","clusterId":"global-v2-cn-1672753017899-dmjnwtzz","clusterName":"test-GlobalView","clusterType":"GlobalViewV2","commercialConfig":{},"createTime":1656579981000,"id":13785300,"isAdvancedClusterInstalled":false,"isClusterRunning":true,"isControllerInstalled":true,"isIntegrationCenter":false,"regionId":"cn-hongkong","updateTime":1657616273000,"userId":"1672753017899"},{"agentStatus":"0","clusterId":"51a123a61a8f31f0","clusterName":"cloud-product-prometheus_cn-qingdao","clusterType":"cloud-product-prometheus","commercialConfig":{},"controllerId":"51a123a61a8f31f0","createTime":1653532488000,"id":13746658,"isAdvancedClusterInstalled":false,"isClusterRunning":true,"isControllerInstalled":true,"isIntegrationCenter":false,"regionId":"cn-qingdao","updateTime":1653532518000,"userId":"1672753017899"}]', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', 'title' => ''], + 'Code' => ['description' => 'The status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'INNER_PROHIBIT', - 'errorMessage' => '内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙', - ], - ], + 'title' => 'ListPrometheusInstances', + 'summary' => 'Obtains all Prometheus instances in a region.', + 'changeSet' => [ + ['createdAt' => '2023-11-20T07:49:39.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-04-21T05:38:16.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-20T10:14:12.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-11T07:48:46.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'StopTimingSyntheticTask', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"[{\\\\\\"agentStatus\\\\\\":\\\\\\"0\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"global-v2-cn-1672753017899-dmjnwtzz\\\\\\",\\\\\\"clusterName\\\\\\":\\\\\\"test-GlobalView\\\\\\",\\\\\\"clusterType\\\\\\":\\\\\\"GlobalViewV2\\\\\\",\\\\\\"commercialConfig\\\\\\":{},\\\\\\"createTime\\\\\\":1656579981000,\\\\\\"id\\\\\\":13785300,\\\\\\"isAdvancedClusterInstalled\\\\\\":false,\\\\\\"isClusterRunning\\\\\\":true,\\\\\\"isControllerInstalled\\\\\\":true,\\\\\\"isIntegrationCenter\\\\\\":false,\\\\\\"regionId\\\\\\":\\\\\\"cn-hongkong\\\\\\",\\\\\\"updateTime\\\\\\":1657616273000,\\\\\\"userId\\\\\\":\\\\\\"1672753017899\\\\\\"},{\\\\\\"agentStatus\\\\\\":\\\\\\"0\\\\\\",\\\\\\"clusterId\\\\\\":\\\\\\"51a123a61a8f31f0\\\\\\",\\\\\\"clusterName\\\\\\":\\\\\\"cloud-product-prometheus_cn-qingdao\\\\\\",\\\\\\"clusterType\\\\\\":\\\\\\"cloud-product-prometheus\\\\\\",\\\\\\"commercialConfig\\\\\\":{},\\\\\\"controllerId\\\\\\":\\\\\\"51a123a61a8f31f0\\\\\\",\\\\\\"createTime\\\\\\":1653532488000,\\\\\\"id\\\\\\":13746658,\\\\\\"isAdvancedClusterInstalled\\\\\\":false,\\\\\\"isClusterRunning\\\\\\":true,\\\\\\"isControllerInstalled\\\\\\":true,\\\\\\"isIntegrationCenter\\\\\\":false,\\\\\\"regionId\\\\\\":\\\\\\"cn-qingdao\\\\\\",\\\\\\"updateTime\\\\\\":1653532518000,\\\\\\"userId\\\\\\":\\\\\\"1672753017899\\\\\\"}]\\",\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'StartTimingSyntheticTask' => [ - 'summary' => 'Starts scheduled synthetic monitoring tasks.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPrometheusIntegration' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TaskIds', + 'name' => 'ClusterId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The task IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task IDs.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12312jejcc23dcewd', - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the Prometheus instance. Only aliyun-cs and ecs instances are supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'c77f6f2397ea74672872acf5e31******', 'title' => ''], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => ['description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kafka', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1F1D8840-5330-5804-A8DB-C3C5C5******'], 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.', - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The queried exporters.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'example' => 'c77f6f2397ea74672872acf5e31******', 'title' => ''], + 'ShowDescribe' => ['description' => 'Indicates whether the description is displayed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'NeedUpgrade' => ['description' => 'Indicates whether an upgrade is required.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'InstanceName' => ['description' => 'The name of the exporter.'."\n", 'type' => 'string', 'example' => 'inet', 'title' => ''], + 'ExporterType' => ['description' => 'The type of the exporter.'."\n", 'type' => 'string', 'example' => 'kafka-exporter', 'title' => ''], + 'IntegrationType' => ['description' => 'The integration type. Valid values: kafka, mysql, redis, snmp, emr, nubela, and tidb.'."\n", 'type' => 'string', 'example' => 'kafka', 'title' => ''], + 'InstanceId' => ['description' => 'The ID of the exporter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '293**', 'title' => ''], + 'Version' => ['description' => 'The version number.'."\n", 'type' => 'string', 'example' => '1.0.0', 'title' => ''], + 'Target' => ['description' => 'The monitored IP address.'."\n", 'type' => 'string', 'example' => '121.40.XX.XX:3342', 'title' => ''], + 'CanDelete' => ['description' => 'Indicates whether the exporter can be deleted.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CanEditor' => ['description' => 'Indicates whether the exporter can be edited.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Status' => ['description' => 'The status of the exporter.'."\n", 'type' => 'string', 'example' => 'installed', 'title' => ''], + 'ContainerName' => ['description' => 'The name of the container.'."\n", 'type' => 'string', 'example' => 'container-1', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.'."\n", 'type' => 'string', 'example' => 'arms-prom', 'title' => ''], + 'PodName' => ['description' => 'The pod name of the exporter.'."\n", 'type' => 'string', 'example' => 'kafka-exporter-1', 'title' => ''], + 'Describe' => ['description' => 'The description of the exporter.'."\n", 'type' => 'string', 'example' => '"{}"', 'title' => ''], + 'ShowLog' => ['description' => 'Indicates whether the exporter logs are displayed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Param' => ['title' => '', 'description' => 'The configurations of the exporter. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '{'."\n" + .' "port": "5554",'."\n" + .' "name": "kafka-test12",'."\n" + .' "kafka_instance": "kafka-test",'."\n" + .' "__label_value": "kafka-test",'."\n" + .' "scrape_interval": 33,'."\n" + .' "metrics_path": "/metrics",'."\n" + .' "__label_key": "kafka-test"'."\n" + .'}'], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'ListPrometheusIntegration', + 'summary' => 'Queries a list of exporters that are integrated into a Prometheus instance. Only aliyun-cs and ecs instances are supported.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusIntegration'], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'StartTimingSyntheticTask', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1F1D8840-5330-5804-A8DB-C3C5C5******\\",\\n \\"Data\\": [\\n {\\n \\"ClusterId\\": \\"c77f6f2397ea74672872acf5e31******\\",\\n \\"ShowDescribe\\": true,\\n \\"NeedUpgrade\\": true,\\n \\"InstanceName\\": \\"inet\\",\\n \\"ExporterType\\": \\"kafka-exporter\\",\\n \\"IntegrationType\\": \\"kafka\\",\\n \\"InstanceId\\": 0,\\n \\"Version\\": \\"1.0.0\\",\\n \\"Target\\": \\"121.40.XX.XX:3342\\",\\n \\"CanDelete\\": true,\\n \\"CanEditor\\": true,\\n \\"Status\\": \\"installed\\",\\n \\"ContainerName\\": \\"container-1\\",\\n \\"Namespace\\": \\"arms-prom\\",\\n \\"PodName\\": \\"kafka-exporter-1\\",\\n \\"Describe\\": \\"\\\\\\"{}\\\\\\"\\",\\n \\"ShowLog\\": true,\\n \\"Param\\": \\"{\\\\n \\\\\\"port\\\\\\": \\\\\\"5554\\\\\\",\\\\n \\\\\\"name\\\\\\": \\\\\\"kafka-test12\\\\\\",\\\\n \\\\\\"kafka_instance\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"__label_value\\\\\\": \\\\\\"kafka-test\\\\\\",\\\\n \\\\\\"scrape_interval\\\\\\": 33,\\\\n \\\\\\"metrics_path\\\\\\": \\\\\\"/metrics\\\\\\",\\\\n \\\\\\"__label_key\\\\\\": \\\\\\"kafka-test\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', ], - 'DeleteTimingSyntheticTask' => [ - 'summary' => 'Deletes a scheduled synthetic monitoring task.', - 'methods' => [ - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListPrometheusMonitoring' => [ + 'summary' => 'Queries the monitoring configuration of a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'list', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2eq4peca****', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The type of the monitoring configuration. Valid values for a Prometheus instance for Container Service: ServiceMonitor, PodMonitor, CustomJob, and Probe. Valid values for a Prometheus instance for ECS: CustomJob and Probe.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'serviceMonitor'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], 'Data' => [ - 'description' => 'Indicates whether the synthetic monitoring task was deleted. true: The synthetic monitoring task was deleted. false: The synthetic monitoring task failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'description' => 'The returned struct.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'ClusterId' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', 'title' => ''], + 'MonitoringName' => ['description' => 'The name of the monitoring configuration.'."\n", 'type' => 'string', 'example' => 'podMonitor1', 'title' => ''], + 'Type' => ['description' => 'The type of the monitoring configuration.'."\n", 'type' => 'string', 'example' => 'podMonitor', 'title' => ''], + 'ConfigYaml' => ['description' => 'The monitoring configuration. The value is a YAML string.'."\n", 'type' => 'string', 'example' => '参见返回参数补充说明。', 'title' => ''], + 'Status' => ['description' => 'The status of the monitoring configuration.'."\n", 'type' => 'string', 'example' => 'run', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => 'task count limited', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => 'You must specify the parameter.', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => 'The specified parameter is invalid.', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => 'The specified region is invalid.', - ], - ], - 403 => [ - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => 'synthetic trail has expired', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => 'synthetic is in debt', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => 'synthetic dailly times has exhausted', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => 'synthetic dailly limited', - ], - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => 'SubUser permission verification failed, the caller is not authorized to perform %s on resource %s.', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => 'STS authorization failed.', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => 'Illegal user access.', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => 'Abnormal commercialization status. Please contact your administrator.', - ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'ListPrometheusMonitoring', + 'responseParamsDescription' => 'ServiceMonitor example:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: ServiceMonitor'."\n" + .' metadata:'."\n" + .' name: tomcat-demo'."\n" + .' namespace: default'."\n" + .' spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' path: /metrics'."\n" + .' port: tomcat-monitor'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: tomcat'."\n" + ."\n" + .'PodMonitor example:'."\n" + ."\n" + .' apiVersion: "monitoring.coreos.com/v1"'."\n" + .' kind: "PodMonitor"'."\n" + .' metadata:'."\n" + .' name: "podmonitor-demo"'."\n" + .' namespace: "default"'."\n" + .' spec:'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: "30s"'."\n" + .' path: "/metrics"'."\n" + .' port: "tomcat-monitor"'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: "nginx2-exporter"'."\n" + ."\n" + .'CustomJob example:'."\n" + ."\n" + .' scrape_configs:'."\n" + .' - job_name: prometheus1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + ."\n" + .'Probe example:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: Probe'."\n" + .' metadata:'."\n" + .' name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox'."\n" + .' namespace: arms-prom'."\n" + .' spec:'."\n" + .' interval: 30s'."\n" + .' jobName: blackbox'."\n" + .' module: tcp_connect'."\n" + .' prober:'."\n" + .' path: /blackbox/probe'."\n" + .' scheme: http'."\n" + .' url: \'localhost:9335\''."\n" + .' targets:'."\n" + .' staticConfig:'."\n" + .' static:'."\n" + .' - \'arms-prom-admin.arms-prom:9335\''."\n", + 'changeSet' => [ + ['createdAt' => '2023-05-25T02:06:32.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusMonitoring'], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', - 'title' => 'DeleteTimingSyntheticTask', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"D80ADAAC-8C32-5479-BD14-C28CF832****\\",\\n \\"Code\\": 200,\\n \\"Data\\": [\\n {\\n \\"ClusterId\\": \\"c589a1b8db05c4561aefbb898ca8fb1cf\\",\\n \\"MonitoringName\\": \\"podMonitor1\\",\\n \\"Type\\": \\"podMonitor\\",\\n \\"ConfigYaml\\": \\"参见返回参数补充说明。\\",\\n \\"Status\\": \\"run\\"\\n }\\n ],\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'GetSyntheticMonitors' => [ - 'summary' => 'Obtains detection points.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListRetcodeApps' => [ + 'summary' => 'Queries the Browser Monitoring tasks in a region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Filter', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'json', + 'schema' => ['description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The query conditions.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskType' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'MonitorCategory' => [ - 'description' => 'The type of the monitoring point. Valid values: 1: PC. 2: mobile device.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', - ], - 'Network' => [ - 'description' => 'The network type. Valid values: 1: private network. 2: Internet.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + 'description' => 'The tags that you want to add to the task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], - 'required' => true, + 'required' => false, + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FD473FF-5398-5A85-9BF6-7AB45561522F', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The list of monitoring points.'."\n", + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', 'title' => ''], + 'RetcodeApps' => [ + 'description' => 'The list of applications monitored by Browser Monitoring.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Country' => [ - 'description' => 'The country.'."\n", - 'type' => 'string', - 'example' => 'China', - ], - 'Region' => [ - 'description' => 'The region.'."\n", - 'type' => 'string', - 'example' => 'Beijing', - ], - 'City' => [ - 'description' => 'The city.'."\n", - 'type' => 'string', - 'example' => 'Beijing', - ], - 'CityCode' => [ - 'description' => 'The city code.'."\n", - 'type' => 'string', - 'example' => '1100101', - ], - 'Operator' => [ - 'description' => 'The carrier.'."\n", - 'type' => 'string', - 'example' => 'Alibaba Cloud', - ], - 'OperatorCode' => [ - 'description' => 'The carrier code.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ClientType' => [ - 'description' => 'The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'CanBeSelected' => [ - 'description' => 'Indicates whether the monitoring point is selected. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Available' => [ - 'description' => 'Indicates whether the monitoring point is available. Valid values: true and false.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'Ipv6' => [ - 'description' => 'Indicates whether IPv6 is supported. Valid values: 0: IPv6 is not supported. 1: IPv6 is supported.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'A1', 'title' => ''], + 'RetcodeAppType' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* `web`: web application'."\n" + .'* `weex`: Weex mobile app'."\n" + .'* `mini_dd`: DingTalk mini program'."\n" + .'* `mini_alipay`: Alipay mini program'."\n" + .'* `mini_wx`: WeChat mini program'."\n" + .'* `mini_common`: mini program on other platforms'."\n", 'type' => 'string', 'example' => 'web', 'title' => ''], + 'AppId' => ['description' => 'The ID of the application. The parameter is an auto-increment parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16064', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], + 'NickName' => ['description' => 'The alias of the application monitored by Browser Monitoring.'."\n", 'type' => 'string', 'example' => 'B1', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], + 'Tags' => [ + 'description' => 'The tags of the task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - ], - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FD473FF-5398-5A85-9BF6-7AB45561522F\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": [\\n {\\n \\"Country\\": \\"中国\\",\\n \\"Region\\": \\"浙江\\",\\n \\"City\\": \\"北京市\\",\\n \\"CityCode\\": \\"1100101\\",\\n \\"Operator\\": \\"阿里云\\",\\n \\"OperatorCode\\": \\"1\\",\\n \\"ClientType\\": 1,\\n \\"CanBeSelected\\": true,\\n \\"Available\\": \\"true\\",\\n \\"Ipv6\\": 0\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetSyntheticMonitors', - ], - 'ListTimingSyntheticTasks' => [ - 'summary' => 'Queries scheduled synthetic monitoring tasks.', - 'methods' => [ - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"99A663CB-8D7B-4B0D-A006-03C8EE38E7BB\\",\\n \\"RetcodeApps\\": [\\n {\\n \\"AppName\\": \\"A1\\",\\n \\"RetcodeAppType\\": \\"web\\",\\n \\"AppId\\": 16064,\\n \\"Pid\\": \\"atc889zkcf@d8deedfa9bf****\\",\\n \\"NickName\\": \\"B1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListRetcodeAppsResponse>\\n<RequestId>99A663CB-8D7B-4B0D-A006-03C8EE38E7BB</RequestId>\\n<RetcodeApps>\\n <RetcodeAppType>web</RetcodeAppType>\\n <AppId>16064</AppId>\\n <Pid>atc889zkcf@d8deedfa9bf****</Pid>\\n <AppName>A1</AppName>\\n</RetcodeApps>\\n</ListRetcodeAppsResponse>","errorExample":""}]', + 'title' => 'ListRetcodeApps', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-28T05:51:31.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-27T12:46:36.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-26T07:41:37.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-21T08:53:27.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'ListScenario' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-zhangjaikou', 'title' => ''], ], [ - 'name' => 'Search', + 'name' => 'Scenario', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The search keyword.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskTypes' => [ - 'description' => 'The task types.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task type. 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'required' => false, - ], - 'TaskIds' => [ - 'description' => 'The task IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The task ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '181248', - ], - 'required' => false, - ], - 'Name' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'AlibabaCloud DNS Task', - ], - 'Status' => [ - 'description' => 'The task status. CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota limit. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: An exception occurs while deleting the task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CREATING', - ], - 'OrderField' => [ - 'description' => 'The condition by which tasks are sorted. You can sort tasks by gmtCreate, gmtModified, status, or monitorCount.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'status', - ], - 'Order' => [ - 'description' => 'The order by which tasks are sorted. 1: ascending order. -1: descending order.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'Page' => [ - 'description' => 'The page number. This parameter is required.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries per page. This parameter is required.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '10', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The scenario where the business monitoring job is used. Valid values:'."\n" + ."\n" + .'* `USER-DEFINED`: user-defined. This is the default value.'."\n" + .'* `EDAS-ROLLOUT`: application release in Enterprise Distributed Application Service (EDAS)'."\n" + .'* `OAM-ROLLOUT`: application release based on Open Application Model (OAM)'."\n" + .'* `MSC-CANARY`: canary release based on Microservice Engine (MSE)'."\n", 'type' => 'string', 'required' => false, 'example' => 'USER-DEFINED', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'The name of the business monitoring job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '测试业务监控', 'title' => ''], ], [ - 'name' => 'Tags', + 'name' => 'AppId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'mark', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1111', - ], - ], - 'required' => false, - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'b590lhguqs@28f515462******', 'title' => ''], + ], + [ + 'name' => 'Sign', + 'in' => 'query', + 'schema' => ['description' => 'The code of the business monitoring job. Set this parameter when you know the code of the business monitoring job you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a9f8****', 'title' => ''], ], ], 'responses' => [ @@ -30906,376 +23408,56 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '730E90FE-996A-5638-99F3-4F0F9038CC6C', - ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => 'The queried tasks.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Name' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'AlibabaCloud DNS Task', - ], - 'TaskType' => [ - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Url' => [ - 'description' => 'The URL for synthetic monitoring.'."\n", - 'type' => 'string', - 'example' => 'https://www.example.com', - ], - 'MonitorCategory' => [ - 'description' => 'The detection point type. 1: PC. 2: mobile device.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Frequency' => [ - 'description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.'."\n", - 'type' => 'string', - 'example' => '1m', - ], - 'MonitorNum' => [ - 'description' => 'The number of detection points.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Status' => [ - 'description' => 'The task status. CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota limit. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: An exception occurs while deleting the task.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'GmtCreate' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '1671454758000', - ], - 'GmtModified' => [ - 'description' => 'The time when the task was modified.'."\n", - 'type' => 'string', - 'example' => '1673085633000', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aekzgwtq5vxxxxx', - ], - 'CommonSetting' => [ - 'description' => 'The general settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomHost' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Hosts' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The custom host settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The destination domain name.'."\n", - 'type' => 'string', - 'example' => 'www.aliyun.com', - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4.'."\n" - .'* 2: IPv6.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Ips' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '39.104.85.210', - ], - ], - ], - ], - ], - 'SelectType' => [ - 'description' => 'The selection mode. Valid values:'."\n" - ."\n" - .'* 0: random'."\n" - .'* 1: polling'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4.'."\n" - .'* 2: IPv6.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MonitorSamples' => [ - 'description' => 'Indicates whether monitoring samples are evenly distributed. Valid values:'."\n" - ."\n" - .'* 0: No'."\n" - .'* 1: Yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsOpenTrace' => [ - 'description' => 'Indicates whether tracing is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'TraceClientType' => [ - 'description' => 'The type of the client for tracing. Valid values:'."\n" - ."\n" - .'* 0: ARMS agent'."\n" - .'* 1: OpenTelemetry'."\n" - .'* 2: Jaeger'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'XtraceRegion' => [ - 'description' => 'The region to which trace data is reported.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'CustomVPCSetting' => [ - 'description' => 'The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.'."\n", - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-zhangjiakou', - ], - 'VpcId' => [ - 'description' => 'The VPC ID.'."\n", - 'type' => 'string', - 'example' => 'vpc-2zehbd4dfzahxxxxxxx', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1bcmj81kxxxxxxx', - ], - 'SecureGroupId' => [ - 'description' => 'The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.'."\n", - 'type' => 'string', - 'example' => 'sg-xxxxxxxxxxxxxx', - ], - ], - ], - 'CustomPrometheusSetting' => [ - 'description' => 'A reserved field.'."\n", - 'type' => 'object', - 'properties' => [ - 'PrometheusLabels' => [ - 'description' => 'A reserved field.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'A reserved field.'."\n", - 'example' => 'Reserved field'."\n", - ], - ], - 'PrometheusClusterId' => [ - 'description' => 'A reserved field.'."\n", - 'type' => 'string', - 'example' => 'Reserved field'."\n", - ], - 'PrometheusClusterRegion' => [ - 'description' => 'A reserved field.'."\n", - 'type' => 'string', - 'example' => 'Reserved field'."\n", - ], - ], - ], - ], - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - ], - ], - 'Total' => [ - 'description' => 'The total number of tasks.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Page' => [ - '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', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '98027D1F-3AEB-492C-A4AA-E9217992****', 'title' => ''], + 'ArmsScenarios' => [ + 'description' => 'The detailed information of the business monitoring job.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The time when the business monitoring job was updated.'."\n", 'type' => 'string', 'example' => '1585214916000', 'title' => ''], + 'AppId' => ['description' => 'The ID of the application.'."\n", 'type' => 'string', 'example' => 'b590lhguqs@28f515462******', 'title' => ''], + 'Sign' => ['description' => 'The code of the business monitoring job.'."\n", 'type' => 'string', 'example' => 'a9f8****', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the business monitoring job was created.'."\n", 'type' => 'string', 'example' => '1585214916000', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'Extensions' => ['description' => 'The extended information. The value is a JSON string.'."\n", 'type' => 'string', 'example' => '{"_MODE": "CUSTOM-TRANSACTION","_SCENARIO": "USER-DEFINED"}', 'title' => ''], + 'Name' => ['description' => 'The name of the business monitoring job.'."\n", 'type' => 'string', 'example' => '测试业务监控', 'title' => ''], + 'Id' => ['description' => 'The ID of the business monitoring job.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '132', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'example' => 'cn-zhangjiakou', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"98027D1F-3AEB-492C-A4AA-E9217992****\\",\\n \\"ArmsScenarios\\": [\\n {\\n \\"UpdateTime\\": \\"1585214916000\\",\\n \\"AppId\\": \\"b590lhguqs@28f515462******\\",\\n \\"Sign\\": \\"a9f8****\\",\\n \\"CreateTime\\": \\"1585214916000\\",\\n \\"UserId\\": \\"113197164949****\\",\\n \\"Extensions\\": \\"{\\\\\\"_MODE\\\\\\": \\\\\\"CUSTOM-TRANSACTION\\\\\\",\\\\\\"_SCENARIO\\\\\\": \\\\\\"USER-DEFINED\\\\\\"}\\",\\n \\"Name\\": \\"测试业务监控\\",\\n \\"Id\\": 132,\\n \\"RegionId\\": \\"cn-zhangjiakou\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'Obtain Business Monitoring Details', + 'summary' => 'Obtain Business Monitoring details.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-08-07T09:21:56.000Z', 'description' => 'Error codes changed'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"730E90FE-996A-5638-99F3-4F0F9038CC6C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"TaskId\\": \\"5308a2691f59422c8c3b7aeccec9cd3b\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"拨测任务\\",\\n \\"TaskType\\": 1,\\n \\"Url\\": \\"https://www.example.com\\",\\n \\"MonitorCategory\\": 1,\\n \\"Frequency\\": \\"1m\\",\\n \\"MonitorNum\\": \\"10\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"1671454758000\\",\\n \\"GmtModified\\": \\"1673085633000\\",\\n \\"ResourceGroupId\\": \\"rg-aekzgwtq5vxxxxx\\",\\n \\"CommonSetting\\": {\\n \\"CustomHost\\": {\\n \\"Hosts\\": [\\n {\\n \\"Domain\\": \\"www.aliyun.com\\",\\n \\"IpType\\": 0,\\n \\"Ips\\": [\\n \\"39.104.85.210\\"\\n ]\\n }\\n ],\\n \\"SelectType\\": 0\\n },\\n \\"IpType\\": 0,\\n \\"MonitorSamples\\": 0,\\n \\"IsOpenTrace\\": false,\\n \\"TraceClientType\\": 1,\\n \\"XtraceRegion\\": \\"cn-hangzhou\\",\\n \\"CustomVPCSetting\\": {\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"VpcId\\": \\"vpc-2zehbd4dfzahxxxxxxx\\",\\n \\"VSwitchId\\": \\"vsw-bp1bcmj81kxxxxxxx\\",\\n \\"SecureGroupId\\": \\"sg-xxxxxxxxxxxxxx\\"\\n },\\n \\"CustomPrometheusSetting\\": {\\n \\"PrometheusLabels\\": {\\n \\"key\\": \\"保留字段。\\\\n\\"\\n },\\n \\"PrometheusClusterId\\": \\"保留字段。\\\\n\\",\\n \\"PrometheusClusterRegion\\": \\"保留字段。\\"\\n }\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 100,\\n \\"Page\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', - 'title' => 'ListTimingSyntheticTasks', + 'ramActions' => [], + 'translator' => 'machine', ], - 'GetTimingSyntheticTask' => [ - 'summary' => 'Obtains the details of a synthetic monitoring task.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'ListSilencePolicies' => [ + 'summary' => 'Queries the information of a silence policy list.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -31283,1026 +23465,173 @@ ], 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The name of the silence policy.'."\n", 'type' => 'string', 'required' => false, 'example' => 'silencepolicy_test'], ], [ - 'name' => 'TaskId', + 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '856566a9cb2a4cafa05aa95ed0ec8f21', - ], + 'schema' => ['title' => '', 'description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1'], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '20'], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'Specifies whether to query the details of a silence policy. Valid values:'."\n" + ."\n" + .'* `true`: Details of the silence policy are queried.'."\n" + .'* `false`: Details about notification policies are not queried.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-beijing', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E13430A6-57A9-56E9-9D8D-28FE8DEBCA40', - ], - 'Code' => [ - 'description' => 'The status code returned. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The message returned.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", + 'RequestId' => ['title' => '', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + 'PageBean' => [ + 'title' => '', + 'description' => 'The returned pages.'."\n", 'type' => 'object', 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', - ], - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'Name' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'AlibabaCloud DNS Task', - ], - 'TaskType' => [ - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'ICMP TCP DNS HTTP Website speed measurement File download'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'MonitorConf' => [ - 'description' => 'The monitoring configurations.'."\n", - 'type' => 'object', - 'properties' => [ - 'NetICMP' => [ - 'description' => 'The ICMP synthetic test parameters. This parameter is required if the TaskType parameter is set to 1.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The destination host IP address or domain name'."\n", - 'type' => 'string', - 'enumValueTitles' => [], - 'example' => 'www.aliyun.com', - ], - 'Interval' => [ - 'description' => 'The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 2000. Default value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'PackageNum' => [ - 'description' => 'The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'PackageSize' => [ - 'description' => 'The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1024', - ], - 'SplitPackage' => [ - 'description' => 'Specifies whether to split ICMP packets. Default value: true.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Timeout' => [ - 'description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2000', - ], - 'TracertEnable' => [ - 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TracertNumMax' => [ - 'description' => 'The maximum number of hops for tracert. Minimum value: 1. Maximum value: 128. Default value: 64.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '64', - ], - 'TracertTimeout' => [ - 'description' => 'The timeout period of tracert. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60000', - ], - ], - ], - 'NetTCP' => [ - 'description' => 'The TCP synthetic tests parameters. This parameter is required if the TaskType parameter is set to 2.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The destination host IP address.'."\n", - 'type' => 'string', - 'example' => '127.0.0.1:8888', - ], - 'ConnectTimes' => [ - 'description' => 'The number of TCP connections that are established in a test. Minimum value: 1. Maximum value: 16. Default value: 4.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Interval' => [ - 'description' => 'The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Timeout' => [ - 'description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20000', - ], - 'TracertEnable' => [ - 'description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'TracertNumMax' => [ - 'description' => 'The maximum number of hops for tracert. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', - ], - 'TracertTimeout' => [ - 'description' => 'The timeout period of tracert. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '60000', - ], - ], - ], - 'NetDNS' => [ - 'description' => 'The DNS synthetic test parameters. This parameter is required if the TaskType parameter is set to 3.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The destination domain name.'."\n", - 'type' => 'string', - 'example' => 'www.aliyun.com', - ], - 'DnsServerIpType' => [ - 'description' => 'The IP version of the DNS server. 0: IPv4. 1: IPv6. 2: A version is automatically selected. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'NsServer' => [ - 'description' => 'The IP address of the DNS server. Default value: 114.114.114.114.'."\n", - 'type' => 'string', - 'example' => '114.114.114.114', - ], - 'QueryMethod' => [ - 'description' => 'The DNS query. 0: recursive, 1: iterative. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Timeout' => [ - 'description' => 'The timeout period for the DNS synthetic test. Unit: milliseconds. The minimum value is 1000 and the maximum value is 45000. Default value: 5000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - ], - ], - ], - 'ApiHTTP' => [ - 'description' => 'The parameters of the HTTP(S) synthetic test.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The URL for synthetic monitoring.'."\n", - 'type' => 'string', - 'example' => 'http://127.0.0.1:8090/api/list', - ], - 'Method' => [ - 'description' => 'The request method.'."\n" - ."\n" - .'* POST'."\n" - .'* GET'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'RequestHeaders' => [ - 'description' => 'The HTTP request header.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Format: JSON map.'."\n", - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - ], - ], - 'RequestBody' => [ - 'description' => 'The HTTP request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Content' => [ - 'description' => 'The content of the request body. Format: JSON string. The parameter is required if the type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.'."\n", - 'type' => 'string', - 'example' => 'text/plain', - ], - 'Type' => [ - 'description' => 'The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.'."\n", - 'type' => 'string', - 'example' => 'multipart/form-data', - ], - ], - ], - 'ConnectTimeout' => [ - 'description' => 'The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - ], - 'Timeout' => [ - 'description' => 'The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10000', - ], - 'CheckCert' => [ - 'description' => 'Whether to verify the certificate. The default is no.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'ProtocolAlpnProtocol' => [ - 'description' => 'The ALPN protocol version. You can configure this parameter when you perform an HTTPS synthetic test on a WAP mobile client. Valid values:'."\n" - ."\n" - .'0: default'."\n" - ."\n" - .'1: HTTP/1.1'."\n" - ."\n" - .'2: HTTP/2'."\n" - ."\n" - .'3: disables the ALPN protocol'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - 'FileDownload' => [ - 'description' => 'The file download parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The file download URL.'."\n", - 'type' => 'string', - 'example' => 'https://********', - ], - 'DownloadKernel' => [ - 'description' => 'The kernel type.'."\n" - ."\n" - .'* 1: curl'."\n" - .'* 0: WinInet'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QuickProtocol' => [ - 'description' => 'The QUIC protocol type.'."\n" - ."\n" - .'* 1: http1'."\n" - .'* 2: http2'."\n" - .'* 3: http3'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ConnectionTimeout' => [ - 'description' => 'The connection timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - ], - 'CustomHeaderContent' => [ - 'description' => 'The content of the custom request header.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - 'description' => 'Format: JSON map.'."\n", - ], - ], - 'IgnoreCertificateStatusError' => [ - 'description' => 'Specifies whether to ignore certificate status errors. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IgnoreCertificateUntrustworthyError' => [ - 'description' => 'Specifies whether to ignore certificate incredibility. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IgnoreInvalidHostError' => [ - 'description' => 'Specifies whether to ignore host invalidity. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '6000', - ], - 'Redirection' => [ - 'description' => 'Specifies whether to support redirection. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'TransmissionSize' => [ - 'description' => 'The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2048', - ], - 'IgnoreCertificateCanceledError' => [ - 'description' => 'Specifies whether to ignore certificate revocation errors. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IgnoreCertificateAuthError' => [ - 'description' => 'Specifies whether to ignore CA certificate authentication errors. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IgnoreCertificateOutOfDateError' => [ - 'description' => 'Specifies whether to ignore certificate invalidity. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IgnoreCertificateUsingError' => [ - 'description' => 'Specifies whether to ignore certificate usage errors. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'VerifyWay' => [ - 'description' => 'Verification method.'."\n" - ."\n" - .'- 0: No verification'."\n" - .'- 1: Verification string'."\n" - .'- 2: MD5 verification', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'ValidateKeywords' => [ - 'description' => 'Verify keywords.', - 'type' => 'string', - 'example' => 'success', - ], - 'WhiteList' => [ - 'description' => 'DNS hijacking whitelist. Matching rules support IP, IP wildcard, subnet mask and CNAME. You can fill in multiple matching rules, and multiple matching rules are separated by vertical bars (|). For example: `www.aliyun.com:203.0.3.55|203.3.44.67`, which means that all IPs except 203.0.3.55 and 203.3.44.67 under the www.aliyun.com domain name are hijacked.', - 'type' => 'string', - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - ], - ], - 'Website' => [ - 'description' => 'The website-speed measurement parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'The destination URL.'."\n", - 'type' => 'string', - 'example' => 'http://www.aliyun.com', - ], - 'AutomaticScrolling' => [ - 'description' => 'Specifies whether to automatically scroll up and down the screen to load a page. 0: No. 1: Yes. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CustomHeader' => [ - 'description' => 'Specifies whether to create a custom header. 0: No. 1: The first packet is modified. 2: All packets are modified. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CustomHeaderContent' => [ - 'description' => 'The custom header. Format: JSON map.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}'."\n", - 'description' => 'JSON Map'."\n", - ], - ], - 'DisableCache' => [ - 'description' => 'Specifies whether to disable the cache. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1'."\n", - ], - 'DisableCompression' => [ - 'description' => 'Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. 0: No. 1: Yes. Default value: 0.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'FilterInvalidIP' => [ - 'description' => 'Specifies whether to exclude invalid IP addresses.'."\n" - ."\n" - .'* 1: No'."\n" - .'* 0: Yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IgnoreCertificateError' => [ - 'description' => 'Specifies whether to ignore SSL certificate errors during browsing. 0: No. 1: Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period. Unit: milliseconds. Default value: 20000. Minimum value: 5000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20000', - ], - 'Redirection' => [ - 'description' => 'Specifies whether to continue browsing after redirection. 0: No, 1:Yes. Default value: 1.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'SlowElementThreshold' => [ - 'description' => 'The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - ], - 'WaitCompletionTime' => [ - 'description' => 'The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5000', - ], - 'VerifyStringBlacklist' => [ - 'description' => 'The verification string is an arbitrary string in the source code of the monitoring page. If the source code returned by the client contains any string in the blacklist, an error 650 "Verification string failed" will be reported. Multiple strings are separated by vertical bars (|).', - 'type' => 'string', - 'example' => 'error', - ], - 'VerifyStringWhitelist' => [ - 'description' => 'The verification string is an arbitrary string in the source code of the monitoring page. The source code returned by the client must contain all the strings in the whitelist, otherwise an error 650 "Verification string failed" will be reported. Multiple strings are separated by a vertical bar (|).', - 'type' => 'string', - 'example' => 'success', - ], - 'ElementBlacklist' => [ - 'description' => 'If an element configured in the element blacklist appears during page loading, no request will be made to load the element.', - 'type' => 'string', - 'example' => 'www.example.com/a.jpg', - ], - 'DNSHijackWhitelist' => [ - 'description' => 'When resolving a domain name (such as www.aliyun.com), if the resolved IP address or CNAME is not in the DNS hijacking whitelist, the user will fail to access or return a non-Aliyun target IP; if the IP or CNAME in the resolution result is in the DNS whitelist, it will be deemed that no DNS hijacking has occurred.'."\n" - ."\n" - .'Fill in the format: `domain name: matching rule`. Matching rules support IP, IP wildcard, subnet mask and CNAME. You can fill in multiple matching rules, and multiple matching rules are separated by vertical bars (|). '."\n" - ."\n" - .'For example: `www.aliyun.com:203.0.3.55|203.3.44.67`, which means that all IPs except 203.0.3.55 and 203.3.44.67 under the www.aliyun.com domain name are hijacked.', - 'type' => 'string', - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - 'PageTamper' => [ - 'description' => 'If any element other than the domain name setting appears on the monitoring page, it means that the page has been tampered. Common manifestations include pop-up ads, floating ads, jumps, etc.'."\n" - ."\n" - .'Fill in the format: `domain name: element`. Elements support wildcards, and multiple elements can be filled in. Multiple elements are separated by vertical bars (|). For example: `www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg`, which means that all elements except the basic document, /cc/bb/a.gif and /vv/bb/cc.jpg under the www.aliyun.com domain name are considered to be tampered with.', - 'type' => 'string', - 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', - ], - 'FlowHijackJumpTimes' => [ - 'description' => 'Identify elements: Set the total number of elements to browse the page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'FlowHijackLogo' => [ - 'description' => 'Hijacking flag: Set the key information for matching. Fill in the hijacking judgment keyword or key element, and asterisks (*) are allowed.', - 'type' => 'string', - 'example' => 'aliyun', - ], - ], - ], - 'Stream' => [ - 'description' => 'Streaming media dial test configuration.', - 'type' => 'object', - 'properties' => [ - 'TargetUrl' => [ - 'description' => 'Streaming media resource address.', - 'type' => 'string', - 'example' => 'http://www.aliyun.com/stream/test.mp4', - ], - 'StreamType' => [ - 'description' => 'Audio and video flag:'."\n" - ."\n" - .'- 0: video'."\n" - .'- 1: audio', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'StreamMonitorTimeout' => [ - 'description' => 'Monitoring duration, in seconds, supports up to 60 seconds. If not specified, the default value is 60 seconds.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '30', - ], - 'StreamAddressType' => [ - 'description' => 'Resource address type:'."\n" - ."\n" - .'- 1: Resource address.'."\n" - .'- 0: Page address. If not passed, the default value is 0.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'PlayerType' => [ - 'description' => 'Player, default is 12 if not specified.'."\n" - ."\n" - .'- 12: VLC'."\n" - .'- 2: Flash Player', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'CustomHeaderContent' => [ - 'description' => 'Custom header, JSON Map format.', - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'description' => 'Custom header, JSON Map format.', - 'example' => '{'."\n" - .' "key1": "value1",'."\n" - .' "key2": "value2"'."\n" - .'}', - ], - ], - 'WhiteList' => [ - 'description' => 'DNS hijacking whitelist. Matching rules support IP, IP wildcard, subnet mask and CNAME. You can fill in multiple matching rules, and multiple matching rules are separated by vertical bars (|). For example: `www.aliyun.com:203.0.3.55|203.3.44.67`, which means that all IPs except 203.0.3.55 and 203.3.44.67 under the www.aliyun.com domain name are hijacked.', - 'type' => 'string', - 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', - ], - ], - ], - ], - ], - 'MonitorCategory' => [ - 'description' => 'The detection point type. 1: PC. 2: mobile device.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Monitors' => [ - 'description' => 'The list of monitoring points.'."\n", + 'Total' => ['title' => '', 'description' => 'The number of silence policies that were returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Page' => ['title' => '', 'description' => 'The number of the page returned.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1'], + 'Size' => ['title' => '', 'description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '20'], + 'SilencePolicies' => [ + 'title' => '', + 'description' => 'The queried silence policies.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The list of monitoring points.', + 'description' => 'A silence policy.'."\n", 'type' => 'object', 'properties' => [ - 'CityCode' => [ - 'description' => 'The city code.'."\n", - 'type' => 'string', - 'example' => '110100', - ], - 'OperatorCode' => [ - 'description' => 'The carrier code.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'ClientType' => [ - 'description' => 'The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - ], - ], - ], - 'Frequency' => [ - 'description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.'."\n", - 'type' => 'string', - 'example' => '5m', - ], - 'CustomPeriod' => [ - 'description' => 'The custom cycle.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndHour' => [ - 'description' => 'The hour at which the test ends. Valid values: 0 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '22', - ], - 'StartHour' => [ - 'description' => 'The hour at which the test starts. Valid values: 0 to 24.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '14', - ], - ], - ], - 'CommonSetting' => [ - 'description' => 'The general settings.'."\n", - 'type' => 'object', - 'properties' => [ - 'CustomHost' => [ - 'description' => 'The custom host.'."\n", - 'type' => 'object', - 'properties' => [ - 'Hosts' => [ - 'description' => 'The list of hosts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The list of hosts.', - 'type' => 'object', - 'properties' => [ - 'Domain' => [ - 'description' => 'The domain name.'."\n", - 'type' => 'string', - 'example' => 'www.aliyun.com', - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4'."\n" - .'* 2: IPv6'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'Ips' => [ - 'description' => 'The list of IP addresses.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The IP address.'."\n", - 'type' => 'string', - 'example' => '10.0.114.17', + 'Id' => ['title' => '', 'description' => 'The ID of the silence policy.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123'], + 'Name' => ['title' => '', 'description' => 'The name of the silence policy.'."\n", 'type' => 'string', 'example' => 'silencepolicy_test'], + 'MatchingRules' => [ + 'title' => '', + 'description' => 'The matching rules.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The matching rule.'."\n", + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'title' => '', + 'description' => 'The matching conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'An array of matching condition objects.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['title' => '', 'description' => 'The key of the matching condition.'."\n", 'type' => 'string', 'example' => 'altertname'], + 'Value' => ['title' => '', 'description' => 'The value of the matching condition.'."\n", 'type' => 'string', 'example' => 'test'], + 'Operator' => ['title' => '', 'description' => 'The logical operator of the matching condition. Valid values:'."\n" + ."\n" + .'* `eq`: equal to'."\n" + .'* `neq`: not equal to'."\n" + .'* `in`: contains'."\n" + .'* `nin`: does not contain'."\n" + .'* `re`: regular expression match'."\n" + .'* `nre`: regular expression mismatch'."\n", 'type' => 'string', 'example' => 'eq'], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'SelectType' => [ - 'description' => 'The selection mode. 0: Random. 1: Polling.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - ], - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4'."\n" - .'* 2: IPv6'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'MonitorSamples' => [ - 'description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" - ."\n" - .'* 0: No'."\n" - .'* 1: Yes'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'IsOpenTrace' => [ - 'description' => 'Whether to enable tracing.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'TraceClientType' => [ - 'description' => 'Tracing client type:'."\n" - ."\n" - .'- 0: ARMS Agent'."\n" - .'- 1: Open Telemetry'."\n" - .'- 2: Jaeger', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'XtraceRegion' => [ - 'description' => 'Tracing data reporting region.', - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'CustomVPCSetting' => [ - 'description' => 'User VPC information. If the dial-up is to the Alibaba Cloud intranet address, you need to configure the VPC information.', - 'type' => 'object', - 'properties' => [ - 'RegionId' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'VpcId' => [ - 'description' => 'VPC ID.', - 'type' => 'string', - 'example' => 'vpc-2zexy5nae9q2otaxxxx', - ], - 'VSwitchId' => [ - 'description' => 'The vSwitch ID.'."\n", - 'type' => 'string', - 'example' => 'vsw-bp1i0xezblf1yrz4xxxxx', - ], - 'SecureGroupId' => [ - 'description' => 'Security group ID. This security group is where the dial-up client is located. The security group limits the inbound and outbound rules of the dial-up client in the VPC. You need to set the inbound rules of the security group where your VPC is located to allow the security group where the dial-up client is located to access. Otherwise, the dial-up client cannot smoothly access the resources in your VPC.', - 'type' => 'string', - 'example' => 'sg-xxxxxxx', - ], - ], - ], - 'CustomPrometheusSetting' => [ - 'description' => 'The reserved parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'PrometheusLabels' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'string', - 'example' => 'Reserved parameter'."\n", - 'description' => 'A reserved parameter.'."\n", - ], - ], - 'PrometheusClusterId' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'Reserved parameter'."\n", - ], - 'PrometheusClusterRegion' => [ - 'description' => 'A reserved parameter.'."\n", - 'type' => 'string', - 'example' => 'Reserved parameter'."\n", - ], - ], - ], - ], - ], - 'AvailableAssertions' => [ - 'description' => 'The list of assertions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.'."\n", - 'type' => 'string', - 'example' => 'websiteTTLB', - ], - 'Target' => [ - 'description' => 'The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.'."\n", - 'type' => 'string', - 'example' => 'key'."\n", - ], - 'Operator' => [ - 'description' => 'The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.'."\n", - 'type' => 'string', - 'example' => 'gt', - ], - 'Expect' => [ - 'description' => 'The expected value.'."\n", - 'type' => 'string', - 'example' => '100', - ], - ], - ], - ], - 'Status' => [ - 'description' => 'CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota insufficiency. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: The task failed to be deleted.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'default', - ], - 'Tags' => [ - 'description' => 'The tag.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'example' => 'user1', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'myweb', + 'example' => '', ], + 'State' => ['title' => '', 'description' => 'Indicates whether the silence policy is enabled. Valid values: enable and disable.'."\n", 'type' => 'string', 'example' => 'enable'], + 'TimeSlots' => ['description' => 'Effective period.'."\n", 'type' => 'string', 'example' => '[{"endTime":"00:00","endWeek":"7","startTime":"00:00","startWeek":"1"}]', 'title' => ''], + 'TimePeriod' => ['description' => 'The effective time. Valid values: WEEK: weekly DAY: daily'."\n", 'type' => 'string', 'example' => 'WEEK', 'title' => ''], + 'EffectiveTimeType' => ['description' => 'The effective type. Valid values: PERMANENT: The policy is effective permanently. CYCLE_EFFECT: The policy is effective cyclically. CUSTOM_TIME: The policy is effective during a custom time period.'."\n", 'type' => 'string', 'example' => 'PERMANENT', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'example' => '', ], ], + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], - ], - 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"SilencePolicies\\": [\\n {\\n \\"Id\\": 123,\\n \\"Name\\": \\"silencepolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"State\\": \\"enable\\",\\n \\"TimeSlots\\": \\"[{\\\\\\"endTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\\\"endWeek\\\\\\":\\\\\\"7\\\\\\",\\\\\\"startTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\\\"startWeek\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"TimePeriod\\": \\"WEEK\\",\\n \\"EffectiveTimeType\\": \\"PERMANENT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSilencePoliciesResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <SilencePolicies>\\n <Id>123</Id>\\n <Name>silencepolicy_test</Name>\\n <MatchingRules>\\n <MatchingConditions>\\n <Key>altertname</Key>\\n <Value>test</Value>\\n <Operator>eq</Operator>\\n </MatchingConditions>\\n </MatchingRules>\\n </SilencePolicies>\\n </PageBean>\\n</ListSilencePoliciesResponse>","errorExample":""}]', + 'title' => 'ListSilencePolicies', + 'changeSet' => [ + ['createdAt' => '2024-08-12T01:35:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2024-05-24T01:43:03.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-07-13T14:50:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-02-24T13:10:13.000Z', 'description' => 'OpenAPI offline'], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSilencePolicies'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E13430A6-57A9-56E9-9D8D-28FE8DEBCA40\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"5308a2691f59422c8c3b7aeccec9cd3b\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"拨测任务\\",\\n \\"TaskType\\": 5,\\n \\"MonitorConf\\": {\\n \\"NetICMP\\": {\\n \\"TargetUrl\\": \\"www.aliyun.com\\",\\n \\"Interval\\": 200,\\n \\"PackageNum\\": 4,\\n \\"PackageSize\\": 1024,\\n \\"SplitPackage\\": true,\\n \\"Timeout\\": 2000,\\n \\"TracertEnable\\": true,\\n \\"TracertNumMax\\": 64,\\n \\"TracertTimeout\\": 60000\\n },\\n \\"NetTCP\\": {\\n \\"TargetUrl\\": \\"127.0.0.1:8888\\",\\n \\"ConnectTimes\\": 4,\\n \\"Interval\\": 200,\\n \\"Timeout\\": 20000,\\n \\"TracertEnable\\": true,\\n \\"TracertNumMax\\": 20,\\n \\"TracertTimeout\\": 60000\\n },\\n \\"NetDNS\\": {\\n \\"TargetUrl\\": \\"www.aliyun.com\\",\\n \\"DnsServerIpType\\": 0,\\n \\"NsServer\\": \\"114.114.114.114\\",\\n \\"QueryMethod\\": 0,\\n \\"Timeout\\": 5000\\n },\\n \\"ApiHTTP\\": {\\n \\"TargetUrl\\": \\"http://127.0.0.1:8090/api/list\\",\\n \\"Method\\": \\"POST\\",\\n \\"RequestHeaders\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"RequestBody\\": {\\n \\"Content\\": \\"text/plain\\",\\n \\"Type\\": \\"multipart/form-data\\"\\n },\\n \\"ConnectTimeout\\": 5000,\\n \\"Timeout\\": 10000,\\n \\"CheckCert\\": false,\\n \\"ProtocolAlpnProtocol\\": 1\\n },\\n \\"FileDownload\\": {\\n \\"TargetUrl\\": \\"https://********\\",\\n \\"DownloadKernel\\": 0,\\n \\"QuickProtocol\\": 1,\\n \\"ConnectionTimeout\\": 5000,\\n \\"CustomHeaderContent\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"IgnoreCertificateStatusError\\": 0,\\n \\"IgnoreCertificateUntrustworthyError\\": 0,\\n \\"IgnoreInvalidHostError\\": 0,\\n \\"MonitorTimeout\\": 6000,\\n \\"Redirection\\": 0,\\n \\"TransmissionSize\\": 2048,\\n \\"IgnoreCertificateCanceledError\\": 0,\\n \\"IgnoreCertificateAuthError\\": 0,\\n \\"IgnoreCertificateOutOfDateError\\": 0,\\n \\"IgnoreCertificateUsingError\\": 0,\\n \\"VerifyWay\\": 0,\\n \\"ValidateKeywords\\": \\"success\\",\\n \\"WhiteList\\": \\"www.aliyun.com:203.0.3.55|203.3.44.67\\"\\n },\\n \\"Website\\": {\\n \\"TargetUrl\\": \\"http://www.aliyun.com\\",\\n \\"AutomaticScrolling\\": 0,\\n \\"CustomHeader\\": 0,\\n \\"CustomHeaderContent\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\\\n\\"\\n },\\n \\"DisableCache\\": 1,\\n \\"DisableCompression\\": 0,\\n \\"FilterInvalidIP\\": 0,\\n \\"IgnoreCertificateError\\": 0,\\n \\"MonitorTimeout\\": 20000,\\n \\"Redirection\\": 1,\\n \\"SlowElementThreshold\\": 5000,\\n \\"WaitCompletionTime\\": 5000,\\n \\"VerifyStringBlacklist\\": \\"error\\",\\n \\"VerifyStringWhitelist\\": \\"success\\",\\n \\"ElementBlacklist\\": \\"www.example.com/a.jpg\\",\\n \\"DNSHijackWhitelist\\": \\"www.aliyun.com:203.0.3.55|203.3.44.67\\",\\n \\"PageTamper\\": \\"www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg\\",\\n \\"FlowHijackJumpTimes\\": 0,\\n \\"FlowHijackLogo\\": \\"aliyun\\"\\n },\\n \\"Stream\\": {\\n \\"TargetUrl\\": \\"http://www.aliyun.com/stream/test.mp4\\",\\n \\"StreamType\\": 0,\\n \\"StreamMonitorTimeout\\": 30,\\n \\"StreamAddressType\\": 0,\\n \\"PlayerType\\": 12,\\n \\"CustomHeaderContent\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"key1\\\\\\": \\\\\\"value1\\\\\\",\\\\n \\\\\\"key2\\\\\\": \\\\\\"value2\\\\\\"\\\\n}\\"\\n },\\n \\"WhiteList\\": \\"www.aliyun.com:203.0.3.55|203.3.44.67\\"\\n }\\n },\\n \\"MonitorCategory\\": 1,\\n \\"Monitors\\": [\\n {\\n \\"CityCode\\": \\"110100\\",\\n \\"OperatorCode\\": \\"1\\",\\n \\"ClientType\\": 1\\n }\\n ],\\n \\"Frequency\\": \\"5m\\",\\n \\"CustomPeriod\\": {\\n \\"EndHour\\": 22,\\n \\"StartHour\\": 14\\n },\\n \\"CommonSetting\\": {\\n \\"CustomHost\\": {\\n \\"Hosts\\": [\\n {\\n \\"Domain\\": \\"www.aliyun.com\\",\\n \\"IpType\\": 0,\\n \\"Ips\\": [\\n \\"10.0.114.17\\"\\n ]\\n }\\n ],\\n \\"SelectType\\": 0\\n },\\n \\"IpType\\": 0,\\n \\"MonitorSamples\\": 0,\\n \\"IsOpenTrace\\": true,\\n \\"TraceClientType\\": 1,\\n \\"XtraceRegion\\": \\"cn-hangzhou\\",\\n \\"CustomVPCSetting\\": {\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"VpcId\\": \\"vpc-2zexy5nae9q2otaxxxx\\",\\n \\"VSwitchId\\": \\"vsw-bp1i0xezblf1yrz4xxxxx\\",\\n \\"SecureGroupId\\": \\"sg-xxxxxxx\\"\\n },\\n \\"CustomPrometheusSetting\\": {\\n \\"PrometheusLabels\\": {\\n \\"key\\": \\"保留字段。\\"\\n },\\n \\"PrometheusClusterId\\": \\"保留字段。\\",\\n \\"PrometheusClusterRegion\\": \\"保留字段。\\"\\n }\\n },\\n \\"AvailableAssertions\\": [\\n {\\n \\"Type\\": \\"websiteTTLB\\",\\n \\"Target\\": \\"key\\\\n\\",\\n \\"Operator\\": \\"gt\\",\\n \\"Expect\\": \\"100\\"\\n }\\n ],\\n \\"Status\\": \\"RUNNING\\",\\n \\"ResourceGroupId\\": \\"default\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"user1\\",\\n \\"Value\\": \\"p_运维\\"\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetTimingSyntheticTask', + 'ramActions' => [], ], 'ListSyntheticDetail' => [ 'summary' => 'Obtains the results of one or more synthetic tests.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'list', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to cn-hangzhou.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region. Set the value to cn-hangzhou.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'SyntheticType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the synthetic test. Valid values: 1 and 2. 1 represents an immediate test, and 2 represents a scheduled test.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The type of the synthetic test. Valid values: 1 and 2. 1 represents an immediate test, and 2 represents a scheduled test.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'Category', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the results. Set the value to SYNTHETIC.', - 'type' => 'string', - 'required' => false, - 'example' => 'SYNTHETIC', - ], + 'schema' => ['description' => 'The type of the results. Set the value to SYNTHETIC.', 'type' => 'string', 'required' => false, 'example' => 'SYNTHETIC', 'title' => ''], ], [ 'name' => 'Detail', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the list that contains the results. This parameter is required. Valid values:'."\n" - ."\n" - .'* ICMP_LIST'."\n" - .'* TCP_LIST'."\n" - .'* DNS_LIST'."\n" - .'* HTTP_LIST'."\n" - .'* WEBSITE_LIST'."\n" - .'* DOWNLOAD_LIST'."\n" - .'* ALL'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ICMP_LIST', - ], + 'schema' => ['description' => 'The type of the list that contains the results. This parameter is required. Valid values:'."\n" + ."\n" + .'* ICMP_LIST'."\n" + .'* TCP_LIST'."\n" + .'* DNS_LIST'."\n" + .'* HTTP_LIST'."\n" + .'* WEBSITE_LIST'."\n" + .'* DOWNLOAD_LIST'."\n" + .'* ALL'."\n", 'type' => 'string', 'required' => false, 'example' => 'ICMP_LIST', 'title' => ''], ], [ 'name' => 'Filters', @@ -32315,11 +23644,9 @@ .'* To query the result details of a synthetic monitoring task, set this parameter in the following format: {"taskId":"${taskId}","dataId":"${dataId}"}.'."\n", 'type' => 'object', 'required' => false, - 'additionalProperties' => [ - 'type' => 'string', - 'example' => '{"taskId":"xxxaaabbbcccdddeeefffggg"} ', - 'description' => 'The filter condition.'."\n", - ], + 'additionalProperties' => ['type' => 'string', 'example' => '{"taskId":"xxxaaabbbcccdddeeefffggg"} ', 'description' => 'The filter condition.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], ], [ @@ -32336,31 +23663,20 @@ 'description' => 'An array of filter conditions.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The filter condition. The taskType and dataId fields are supported.'."\n" - ."\n" - .'* To query the list of synthetic test results, set the key to taskType.'."\n" - .'* To query the result details of a synthetic monitoring task, set the key to dataId.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'taskType', - ], - 'OpType' => [ - 'description' => 'The type of the filter condition. Valid values: eq and in. eq: equal to. in: include.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'eq', - ], - 'Value' => [ - 'description' => 'The value of the filter condition. The type of the task. Valid values: 1: ICMP 2: TCP 3: DNS 4: HTTP 5: website speed measurement 6: file download'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '1', - ], + 'Key' => ['description' => 'The filter condition. The taskType and dataId fields are supported.'."\n" + ."\n" + .'* To query the list of synthetic test results, set the key to taskType.'."\n" + .'* To query the result details of a synthetic monitoring task, set the key to dataId.'."\n", 'type' => 'string', 'required' => false, 'example' => 'taskType', 'title' => ''], + 'OpType' => ['description' => 'The type of the filter condition. Valid values: eq and in. eq: equal to. in: include.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eq', 'title' => ''], + 'Value' => ['description' => 'The value of the filter condition. The type of the task. Valid values: 1: ICMP 2: TCP 3: DNS 4: HTTP 5: website speed measurement 6: file download'."\n", 'type' => 'any', 'required' => false, 'example' => '1', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ @@ -32374,97 +23690,52 @@ 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'A reserved field.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'OpType' => [ - 'description' => 'A reserved field.', - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], - 'Value' => [ - 'description' => 'A reserved field.', - 'type' => 'any', - 'required' => false, - 'example' => 'null', - ], + 'Key' => ['description' => 'A reserved field.', 'type' => 'string', 'required' => false, 'example' => '保留字段。', 'title' => ''], + 'OpType' => ['description' => 'A reserved field.', 'type' => 'string', 'required' => false, 'example' => '保留字段。', 'title' => ''], + 'Value' => ['description' => 'A reserved field.', 'type' => 'any', 'required' => false, 'example' => '保留字段。', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 100, + 'title' => '', + 'example' => '', ], ], [ 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp of the start time of the query. Unit: milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1684110343127', - ], + 'schema' => ['description' => 'The timestamp of the start time of the query. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1684110343127', 'title' => ''], ], [ 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The timestamp of the end time of the query. Unit: milliseconds.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1684480557772', - ], + 'schema' => ['description' => 'The timestamp of the end time of the query. Unit: milliseconds.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1684480557772', 'title' => ''], ], [ 'name' => 'OrderBy', 'in' => 'query', - 'schema' => [ - 'description' => 'The field based on which results are sorted. Set the value to timestamp.', - 'type' => 'string', - 'required' => false, - 'example' => 'timestamp', - ], + 'schema' => ['description' => 'The field based on which results are sorted. Set the value to timestamp.', 'type' => 'string', 'required' => false, 'example' => 'timestamp', 'title' => ''], ], [ 'name' => 'Order', 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which results are sorted. Valid values:'."\n" - ."\n" - .'- `ASC`: ascending order'."\n" - .'- `DESC`: descending order', - 'type' => 'string', - 'required' => false, - 'example' => 'DESC', - ], + 'schema' => ['description' => 'The order in which results are sorted. Valid values:'."\n" + ."\n" + .'- `ASC`: ascending order'."\n" + .'- `DESC`: descending order', 'type' => 'string', 'required' => false, 'example' => 'DESC', 'title' => ''], ], [ 'name' => 'Page', 'in' => 'query', - 'schema' => [ - 'description' => 'The page number. Pages start from page 1.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'The page number. Pages start from page 1.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], ], [ 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries per page.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], ], ], 'responses' => [ @@ -32473,23 +23744,9 @@ 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '70675725-8F11-4817-8106-CFE0AD71****', - ], - 'Code' => [ - 'description' => 'The HTTP status code returned. The status code 200 indicates that the request was successful.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned.', - 'type' => 'string', - 'example' => 'null', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request', 'type' => 'string', 'example' => '70675725-8F11-4817-8106-CFE0AD71****'], + 'Code' => ['description' => 'The HTTP status code returned. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned.', 'type' => 'string', 'example' => 'null', 'title' => ''], 'Data' => [ 'description' => 'The returned struct.'."\n", 'type' => 'object', @@ -32500,163 +23757,98 @@ 'items' => [ 'description' => 'The list of results.'."\n", 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The results details.'."\n", - 'example' => '{'."\n" - .' "requestId": "9A82BD90-4A42-5E25-9DA1-D85A2D4AA696",'."\n" - .' "code": "200",'."\n" - .' "message": null,'."\n" - .' "action": null,'."\n" - .' "apiName": null,'."\n" - .' "extendedCode": null,'."\n" - .' "bizCode": null,'."\n" - .' "httpStatusCode": "200",'."\n" - .' "accessDeniedDetail": null,'."\n" - .' "data": {'."\n" - .' "RequestId": "9A82BD90-4A42-5E25-9DA1-D85A2D4xxxxx",'."\n" - .' "Data": {'."\n" - .' "PageSize": 999,'."\n" - .' "Total": 1,'."\n" - .' "Page": 1,'."\n" - .' "Items": ['."\n" - .' {'."\n" - .' "__time__": 1710115743,'."\n" - .' "ipIsp": "aliyun",'."\n" - .' "targetCity": "",'."\n" - .' "ipCity": "Virginia",'."\n" - .' "__source__": "",'."\n" - .' "resultCode": "2400",'."\n" - .' "icmpLossRate": "20",'."\n" - .' "ipCountry": "USA",'."\n" - .' "tracertHops": "0",'."\n" - .' "url": "www.aliyun.com",'."\n" - .' "targetIp": "47.88.XX.XX",'."\n" - .' "targetOperator": "aliyun",'."\n" - .' "clientType": "4",'."\n" - .' "dataId": "377a04e1cd5a4adc8fb0f249666xxxxx",'."\n" - .' "tracertTime": "null",'."\n" - .' "clientLastIp": "21.0.XX.XX",'."\n" - .' "errName": "null",'."\n" - .' "ipRegion": "USA",'."\n" - .' "taskName": "Aliyun Dial-up Test Point",'."\n" - .' "icmpTime": "229",'."\n" - .' "timestamp": "1710137152606"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "Code": 200'."\n" - .' },'."\n" - .' "successResponse": true'."\n" - .'}', - ], + 'additionalProperties' => ['type' => 'any', 'description' => 'The results details.'."\n", 'example' => '{'."\n" + .' "requestId": "9A82BD90-4A42-5E25-9DA1-D85A2D4AA696",'."\n" + .' "code": "200",'."\n" + .' "message": null,'."\n" + .' "action": null,'."\n" + .' "apiName": null,'."\n" + .' "extendedCode": null,'."\n" + .' "bizCode": null,'."\n" + .' "httpStatusCode": "200",'."\n" + .' "accessDeniedDetail": null,'."\n" + .' "data": {'."\n" + .' "RequestId": "9A82BD90-4A42-5E25-9DA1-D85A2D4xxxxx",'."\n" + .' "Data": {'."\n" + .' "PageSize": 999,'."\n" + .' "Total": 1,'."\n" + .' "Page": 1,'."\n" + .' "Items": ['."\n" + .' {'."\n" + .' "__time__": 1710115743,'."\n" + .' "ipIsp": "阿里云",'."\n" + .' "targetCity": "",'."\n" + .' "ipCity": "弗吉尼亚",'."\n" + .' "__source__": "",'."\n" + .' "resultCode": "2400",'."\n" + .' "icmpLossRate": "20",'."\n" + .' "ipCountry": "美国",'."\n" + .' "tracertHops": "0",'."\n" + .' "url": "www.aliyun.com",'."\n" + .' "targetIp": "47.88.XX.XX",'."\n" + .' "targetOperator": "阿里云",'."\n" + .' "clientType": "4",'."\n" + .' "dataId": "377a04e1cd5a4adc8fb0f249666xxxxx",'."\n" + .' "tracertTime": "null",'."\n" + .' "clientLastIp": "21.0.XX.XX",'."\n" + .' "errName": "null",'."\n" + .' "ipRegion": "美国",'."\n" + .' "taskName": "阿里云拨测点",'."\n" + .' "icmpTime": "229",'."\n" + .' "timestamp": "1710137152606"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "Code": 200'."\n" + .' },'."\n" + .' "successResponse": true'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => 'The total number of entries.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '12', - ], - 'Page' => [ - 'description' => 'The page number.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'PageSize' => [ - 'description' => 'The number of entries returned on each page.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '10', - ], - 'TaskCreateTime' => [ - 'description' => 'A reserved field.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'null', - ], + 'Total' => ['description' => 'The total number of entries.', 'type' => 'integer', 'format' => 'int32', 'example' => '12', 'title' => ''], + 'Page' => ['description' => 'The page number.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned on each page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TaskCreateTime' => ['description' => 'A reserved field.', 'type' => 'integer', 'format' => 'int64', 'example' => '保留字段。', 'title' => ''], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], 'errorCodes' => [ 400 => [ - [ - 'errorCode' => 'ParameterMissing', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'TaskQuotaLimit', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'ParameterRegionIllegal', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', - ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', - ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', - ], + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], ], 403 => [ - [ - 'errorCode' => 'RAMNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'STSNotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'IllegalUserAccess', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'CommercialStatusException', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticTrailExpired', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticInDebt', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyTimesExhausted', - 'errorMessage' => '%s', - ], - [ - 'errorCode' => 'SyntheticDailyLimit', - 'errorMessage' => '%s', - ], - ], - ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"null\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"key\\": \\"{\\\\n \\\\\\"requestId\\\\\\": \\\\\\"9A82BD90-4A42-5E25-9DA1-D85A2D4AA696\\\\\\",\\\\n \\\\\\"code\\\\\\": \\\\\\"200\\\\\\",\\\\n \\\\\\"message\\\\\\": null,\\\\n \\\\\\"action\\\\\\": null,\\\\n \\\\\\"apiName\\\\\\": null,\\\\n \\\\\\"extendedCode\\\\\\": null,\\\\n \\\\\\"bizCode\\\\\\": null,\\\\n \\\\\\"httpStatusCode\\\\\\": \\\\\\"200\\\\\\",\\\\n \\\\\\"accessDeniedDetail\\\\\\": null,\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"RequestId\\\\\\": \\\\\\"9A82BD90-4A42-5E25-9DA1-D85A2D4xxxxx\\\\\\",\\\\n \\\\\\"Data\\\\\\": {\\\\n \\\\\\"PageSize\\\\\\": 999,\\\\n \\\\\\"Total\\\\\\": 1,\\\\n \\\\\\"Page\\\\\\": 1,\\\\n \\\\\\"Items\\\\\\": [\\\\n {\\\\n \\\\\\"__time__\\\\\\": 1710115743,\\\\n \\\\\\"ipIsp\\\\\\": \\\\\\"阿里云\\\\\\",\\\\n \\\\\\"targetCity\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"ipCity\\\\\\": \\\\\\"弗吉尼亚\\\\\\",\\\\n \\\\\\"__source__\\\\\\": \\\\\\"\\\\\\",\\\\n \\\\\\"resultCode\\\\\\": \\\\\\"2400\\\\\\",\\\\n \\\\\\"icmpLossRate\\\\\\": \\\\\\"20\\\\\\",\\\\n \\\\\\"ipCountry\\\\\\": \\\\\\"美国\\\\\\",\\\\n \\\\\\"tracertHops\\\\\\": \\\\\\"0\\\\\\",\\\\n \\\\\\"url\\\\\\": \\\\\\"www.aliyun.com\\\\\\",\\\\n \\\\\\"targetIp\\\\\\": \\\\\\"47.88.XX.XX\\\\\\",\\\\n \\\\\\"targetOperator\\\\\\": \\\\\\"阿里云\\\\\\",\\\\n \\\\\\"clientType\\\\\\": \\\\\\"4\\\\\\",\\\\n \\\\\\"dataId\\\\\\": \\\\\\"377a04e1cd5a4adc8fb0f249666xxxxx\\\\\\",\\\\n \\\\\\"tracertTime\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"clientLastIp\\\\\\": \\\\\\"21.0.XX.XX\\\\\\",\\\\n \\\\\\"errName\\\\\\": \\\\\\"null\\\\\\",\\\\n \\\\\\"ipRegion\\\\\\": \\\\\\"美国\\\\\\",\\\\n \\\\\\"taskName\\\\\\": \\\\\\"阿里云拨测点\\\\\\",\\\\n \\\\\\"icmpTime\\\\\\": \\\\\\"229\\\\\\",\\\\n \\\\\\"timestamp\\\\\\": \\\\\\"1710137152606\\\\\\"\\\\n }\\\\n ]\\\\n },\\\\n \\\\\\"Code\\\\\\": 200\\\\n },\\\\n \\\\\\"successResponse\\\\\\": true\\\\n}\\"\\n }\\n ],\\n \\"Total\\": 12,\\n \\"Page\\": 1,\\n \\"PageSize\\": 10,\\n \\"TaskCreateTime\\": 0\\n }\\n}","type":"json"}]', 'title' => 'ListSyntheticDetail', + 'description' => '云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。', 'requestParamsDescription' => 'The query of synthetic test results contains two steps. Take a ping synthetic test as an example.'."\n" ."\n" .'Step 1: Query a result list:'."\n" @@ -32668,2549 +23860,888 @@ .'{"RegionId":"cn-hangzhou","StartTime":1710115743153,"EndTime":1710137343153,"SyntheticType":2,"Category":"SYNTHETIC","Detail":"ICMP_LIST","AdvancedFilters":[{"Key":"dataId","OpType":"eq","Value":"$dataId"}],"Page":1,"PageSize":999,"Filters":{"dataId":"$dataId"}}'."\n" ."\n" .'Replace $dataId with the dataId field in each record that is returned in Step 1.', - ], - 'CreateSyntheticTask' => [ - 'summary' => 'Creates or updates a synthetic monitoring task.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSyntheticDetail'], + ], ], + 'ramActions' => [], + ], + 'ListTimingSyntheticTasks' => [ + 'summary' => 'Queries scheduled synthetic monitoring tasks.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'list'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the application is located.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'TaskName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the task. To update a synthetic monitoring task, enter the task name and set the **UpdateTask** parameter to **true**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Network synthetic monitoring task'."\n", - ], - ], - [ - 'name' => 'Url', - 'in' => 'query', - 'schema' => [ - 'description' => 'The URL for synthetic monitoring.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://www.example.com', - ], - ], - [ - 'name' => 'MonitorList', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The list of monitoring points.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CityCode' => [ - 'description' => 'The ID of the city to which the monitoring point belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1100101', - ], - 'NetServiceId' => [ - 'description' => 'The ID of the carrier.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '18', - ], - 'MonitorType' => [ - 'description' => 'The carrier type:'."\n" - ."\n" - .'* IDC'."\n" - .'* LastMilie'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => 'IDC', - ], - ], - 'required' => false, - ], - 'required' => true, - ], - ], - [ - 'name' => 'TaskType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the monitoring task. Valid values:'."\n" - ."\n" - .'1. 3: web page performance - IE'."\n" - .'2. 34: web Page Performance - Chrome'."\n" - .'3. 0: network quality'."\n" - .'4. 40: file download'."\n" - .'5. 7:API performance'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'IntervalTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval at which synthetic monitoring is performed. Unit: minutes. Valid values:'."\n" - ."\n" - .'* 1'."\n" - .'* 5'."\n" - .'* 10'."\n" - .'* 15'."\n" - .'* 20'."\n" - .'* 30'."\n" - .'* 60'."\n" - .'* 120'."\n" - .'* 180'."\n" - .'* 240'."\n" - .'* 360'."\n" - .'* 480'."\n" - .'* 720'."\n" - .'* 1440'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '5', - ], - ], - [ - 'name' => 'IntervalType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The interval type.'."\n" - ."\n" - .'* 0: daily'."\n" - .'* 1: custom frequency'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '0', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ExtendInterval', + 'name' => 'Search', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The frequency.'."\n", + 'description' => 'The search keyword.'."\n", 'type' => 'object', 'properties' => [ - 'StartTime' => [ - 'description' => 'The time when synthetic monitoring starts. The format is `yyyy-MM-dd HH`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-07-20 10', - ], - 'EndTime' => [ - 'description' => 'The time when synthetic monitoring ends. The format is `yyyy-MM-dd HH`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-08-20 10', - ], - 'Days' => [ - 'description' => 'The day on which synthetic monitoring is performed.'."\n", + 'TaskTypes' => [ + 'description' => 'The task types.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The day on which synthetic monitoring is performed.'."\n" - ."\n" - .'* \\-1: every day'."\n" - .'* 0: Sunday'."\n" - .'* 1: Monday'."\n" - .'* 2: Tuesday'."\n" - .'* 3: Wednesday'."\n" - .'* 4: Thursday'."\n" - .'* 5: Friday'."\n" - .'* 6: Saturday'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'items' => ['description' => 'The task type. 1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], 'required' => false, + 'title' => '', + 'example' => '', ], - 'StartHour' => [ - 'description' => 'The hour at which synthetic monitoring starts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '00', - ], - 'StartMinute' => [ - 'description' => 'The minute at which synthetic monitoring starts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '00', - ], - 'EndHour' => [ - 'description' => 'The hour at which synthetic monitoring ends.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '23', - ], - 'EndMinute' => [ - 'description' => 'The minute at which synthetic monitoring ends.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '00', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'IpType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IP address type:'."\n" - ."\n" - .'* 0: an automatic IP address'."\n" - .'* 1: IPv4'."\n" - .'* 2: IPv6'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '0', - ], - ], - [ - 'name' => 'Net', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The network synthetic monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'NetICMPSwitch' => [ - 'description' => 'Specifies whether to enable ping monitoring.'."\n" - ."\n" - .'* 0: Off.'."\n" - .'* 1: On. You must set Internet control message protocol (ICMP) parameters if you want to enable ping monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NetICMPActive' => [ - 'description' => 'The protocol type. Valid values:'."\n" - ."\n" - .'* 0: ICMP'."\n" - .'* 1: TCP'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'NetICMPInterval' => [ - 'description' => 'The interval at which the network synthetic monitoring task is executed. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NetICMPNum' => [ - 'description' => 'The number of packages.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '4', - ], - 'NetICMPSize' => [ - 'description' => 'The package size.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '32', - ], - 'NetDNSSwitch' => [ - 'description' => 'Specifies whether to enable domain name system (DNS) monitoring.'."\n" - ."\n" - .'* 0: Off.'."\n" - .'* 1: On. You must set DNS parameters if you want to enable DNS monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NetDNSTimeout' => [ - 'description' => 'The timeout period of DNS monitoring. Default value: 5 seconds. Valid values: 0 to 45 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '5', - ], - 'NetDNSQueryMethod' => [ - 'description' => 'The DNS query method. Valid values:'."\n" - ."\n" - .'* 1: recursion'."\n" - .'* 2: iteration'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NetDNSNs' => [ - 'description' => 'The DNS server.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '114.114.XX.XX', - ], - 'NetDigSwitch' => [ - 'description' => 'Specifies whether to display the data in the DIG format. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'NetDNSServer' => [ - 'description' => 'The IP address type of the DNS server.'."\n" - ."\n" - .'* 0: IPv4'."\n" - .'* 1: IPv6'."\n" - .'* 2: an automatic IP address'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'NetTraceRouteSwitch' => [ - 'description' => 'Specifies whether to enable tracert monitoring.'."\n" - ."\n" - .'* 0: Off.'."\n" - .'* 1: On. You must set the tracert parameters if you want to enable tracert monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NetTraceRouteTimeout' => [ - 'description' => 'The timeout period of tracert monitoring. Valid values: 0 to 300 seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '60', - ], - 'NetTraceRouteNum' => [ - 'description' => 'The maximum number of active monitoring points.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - 'WhiteList' => [ - 'description' => 'The whitelist for DNS hijacking. The format is `Domain name: Matching rule`.'."\n" - ."\n" - .'> Wireless application protocol (WAP) networks do not support DNS hijacking.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:202.0.3.55|203.3.44.67', - ], - 'NetICMPTimeout' => [ - 'description' => 'The timeout period of Ping monitoring.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '20', - ], - 'NetICMPDataCut' => [ - 'description' => 'Specifies whether to split packages.'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], - ], - [ - 'name' => 'CommonParam', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The common parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlarmFlag' => [ - 'description' => 'Specifies whether to create an alert rule.'."\n" - ."\n" - .'* 1: creates an alert.'."\n" - .'* 0: does not create an alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'AlertList' => [ - 'description' => 'The alert parameters.'."\n", + 'TaskIds' => [ + 'description' => 'The task IDs.'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the alert rule.'."\n" - ."\n" - .'For network synthetic monitoring, use the following names:'."\n" - ."\n" - .'* Latency: PING_SET'."\n" - .'* Packet loss rate: PING_LOST_RATE'."\n" - .'* Hijacking: HIJACKPER'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PING_SET', - ], - 'IsCritical' => [ - 'description' => 'Specifies whether the condition must be met.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => 'true', - ], - 'Symbols' => [ - 'description' => 'Specifies how the condition is evaluated. Valid values:'."\n" - ."\n" - .'* 1: greater than'."\n" - .'* 0: less than'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'AlertPolicyId' => [ - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1234', - ], - 'AlertNotifierId' => [ - 'description' => 'The ID of the alert recipient. Separate multiple recipients with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], - 'StartExecutionTime' => [ - 'description' => 'The time when execution starts.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'items' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '181248', 'title' => ''], 'required' => false, - 'example' => '2022-07-20 10', - ], - 'MonitorSamples' => [ - 'description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', + 'title' => '', + 'example' => '', ], + 'Name' => ['description' => 'The task name.'."\n", 'type' => 'string', 'required' => false, 'example' => '拨测', 'title' => ''], + 'Status' => ['description' => 'The task status. CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota limit. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: An exception occurs while deleting the task.'."\n", 'type' => 'string', 'required' => false, 'example' => 'CREATING', 'title' => ''], + 'OrderField' => ['description' => 'The condition by which tasks are sorted. You can sort tasks by gmtCreate, gmtModified, status, or monitorCount.'."\n", 'type' => 'string', 'required' => false, 'example' => 'status', 'title' => ''], + 'Order' => ['description' => 'The order by which tasks are sorted. 1: ascending order. -1: descending order.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'Page' => ['description' => 'The page number. This parameter is required.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page. This parameter is required.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Navigation', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The monitoring items that are associated with the browse tasks.'."\n", - 'type' => 'object', - 'properties' => [ - 'NavDisableCache' => [ - 'description' => 'Specifies whether to disable caching.'."\n" - ."\n" - .'* 1: disable'."\n" - .'* 0: enable'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NavReturnElement' => [ - 'description' => 'Specifies whether to return the elements on the page.'."\n" - ."\n" - .'* 1: no. Returns the basic document data.'."\n" - .'* 2: yes. Returns all document data.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], - 'NavRedirection' => [ - 'description' => 'Specifies whether to continue browsing after a redirection occurs.'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NavDisableCompression' => [ - 'description' => 'Specifies whether to enable the feature of using the Accept-Encoding field to determine whether to accept compressed files.'."\n" - ."\n" - .'* 1: disable'."\n" - .'* 0: enable'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'NavAutomaticScrolling' => [ - 'description' => 'Specifies whether to automatically scroll up and down the screen to load a page.'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'NavIgnoreCertificateError' => [ - 'description' => 'Specifies whether to ignore certificate errors during certificate verification in the SSL handshake and continue browsing.'."\n" - ."\n" - .'* 1: ignore'."\n" - .'* 0: does not ignore'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'FilterInvalidIP' => [ - 'description' => 'Specifies whether to filter invalid IP addresses.'."\n" - ."\n" - .'* 1: no'."\n" - .'* 0: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'ExecuteApplication' => [ - 'description' => 'Specifies whether to run applets.'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n" - ."\n" - .'> This parameter is supported only by IE Full Elements.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'ExecuteActiveX' => [ - 'description' => 'Specifies whether to execute ActiveX.'."\n" - ."\n" - .'* 3: yes'."\n" - .'* 0: no'."\n" - ."\n" - .'> This parameter is supported only by IE Full Elements.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], - 'ExecuteScript' => [ - 'description' => 'Specifies whether to execute scripts.'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n" - ."\n" - .'> This parameter is supported only by IE Full Elements.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'QUICVersion' => [ - 'description' => 'The Quick UDP Internet Connections (QUIC) protocol version. Default value: 0. Valid values:'."\n" - ."\n" - .'*'."\n" - .'* 35'."\n" - .'* 39'."\n" - .'* 43'."\n" - .'* 44'."\n" - ."\n" - .'> This parameter is supported by all elements of only Chrome'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'QUICDomain' => [ - 'description' => 'The domain name of the QUIC request element.'."\n" - ."\n" - .'> This parameter is supported by all elements of only Chrome'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com', - ], - 'RequestHeader' => [ - 'description' => 'Specifies whether to return the request header.'."\n" - ."\n" - .'* 0: does not return the response header.'."\n" - .'* 1: returns the basic document header.'."\n" - .'* 2: returns all headers.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'NavCustomHost' => [ - 'description' => 'The custom host mode.'."\n" - ."\n" - .'* 1: round robin'."\n" - .'* 0: random'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'NavCustomHostIp' => [ - 'description' => 'The custom host IP address. You can enter multiple IP addresses. Separate the IP addresses with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com', - ], - 'NavCustomHeader' => [ - 'description' => 'The method that is used to customize the header. Valid values:'."\n" - ."\n" - .'* 0: disables the customer header.'."\n" - .'* 1: modifies the first package.'."\n" - .'* 2: modifies all packages.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], - 'NavCustomHeaderContent' => [ - 'description' => 'The format of the custom header. You can specify multiple fields. Separate the fields with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Host:www.example.com|Referer:www.example.com', - ], - 'ElementBlacklist' => [ - 'description' => 'The element blacklist.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '*.a.com', - ], - 'ProcessName' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ssh', - ], - 'VerifyStringBlacklist' => [ - 'description' => 'The blacklist for string verification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Regex:*.example|expalme|', - ], - 'VerifyStringWhiteList' => [ - 'description' => 'The whitelist for string verification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Regex:*.example|expalme|', - ], - 'MonitorTimeout' => [ - 'description' => 'The timeout period of monitoring. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '20', - ], - 'WaitCompletionTime' => [ - 'description' => 'The timeout period of waiting for the monitoring to complete.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '15', - ], - 'SlowElementThreshold' => [ - 'description' => 'The time threshold that is used to define a slow element. Unit: seconds.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '5', - ], - 'DNSHijackWhiteList' => [ - 'description' => 'The whitelist for DNS hijacking.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.aliyun.com:202.0.3.55|203.3.44.67', - ], - 'PageTamper' => [ - 'description' => 'The web page defacement.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'www.example.com:202.0.3.55|203.3.44.67', - ], - 'FlowHijackJumpTimes' => [ - 'description' => 'The element that is used in DNS hijacking.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '50', - ], - 'FlowHijackLogo' => [ - 'description' => 'The tag that is used in DNS hijacking.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', - ], - 'ResponseHeader' => [ - 'description' => 'The method that is used to return the response header. Valid values:'."\n" - ."\n" - .'* 0: does not return the response header.'."\n" - .'* 1: returns the basic document header.'."\n" - .'* 2: returns all headers.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - ], - 'required' => false, - ], + 'schema' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ - 'name' => 'Download', + 'name' => 'Tags', 'in' => 'query', 'style' => 'json', 'schema' => [ - 'description' => 'The file download task.'."\n", - 'type' => 'object', - 'properties' => [ - 'DownloadTransmissionSize' => [ - 'description' => 'The size of the download file. Unit: KB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10240', - ], - 'DownloadCustomHost' => [ - 'description' => 'The custom host mode.'."\n" - ."\n" - .'* 1: round robin'."\n" - .'* 0: random'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'DownloadCustomHostIp' => [ - 'description' => 'The custom host IP address. You can enter multiple IP addresses. Separate the IP addresses with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com', - ], - 'WhiteList' => [ - 'description' => 'The whitelist for DNS hijacking.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{\\"src\\":\\"211.154.166.174\\"}]', - ], - 'DownloadKernel' => [ - 'description' => 'The kernel type.'."\n" - ."\n" - .'* 1: curl'."\n" - .'* 0: WinInet'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'QuickProtocol' => [ - 'description' => 'The QUIC protocol type.'."\n" - ."\n" - .'* 1: http1'."\n" - .'* 2: http2'."\n" - .'* 3: http3'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring duration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '30', - ], - 'ConnectionTimeout' => [ - 'description' => 'The connection timeout period.'."\n", - 'type' => 'number', - 'format' => 'double', - 'required' => false, - 'example' => '200', - ], - 'VerifyWay' => [ - 'description' => 'The verification method.'."\n" - ."\n" - .'* 0: no verification'."\n" - .'* 1: string verification'."\n" - .'* 2: MD5 verification'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'ValidateKeywords' => [ - 'description' => 'The keyword that is used in verification.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'keyword', - ], - 'DownloadRedirection' => [ - 'description' => 'Specifies whether to support redirection.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'DownloadCustomHeaderContent' => [ - 'description' => 'The items to be ignored in a certificate error. Pass the values of the check boxes that are separated with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Host:www.example.com|Referer:www.example.com', - ], - 'DownloadIgnoreCertificateError' => [ - 'description' => 'The items to be ignored in a certificate error. Pass the values of the check boxes that are separated with vertical bars (|).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1|2|4', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'mark', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value1111', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Protocol', - 'in' => 'query', - 'style' => 'json', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The API performance synthetic monitoring task.'."\n", 'type' => 'object', 'properties' => [ - 'RequestContent' => [ - 'description' => 'The request content, including the request header and request body.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '730E90FE-996A-5638-99F3-4F0F9038CC6C'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => [ + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'Method' => [ - 'description' => 'The request method.'."\n" - ."\n" - .'* POST'."\n" - .'* GET'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'POST', - ], - 'Header' => [ - 'description' => 'The custom header of a request to initiate an API performance synthetic monitoring task.'."\n", + 'Items' => [ + 'description' => 'The queried tasks.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The information about the task.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'regionId', - ], - 'Value' => [ - 'description' => 'The value of the request header.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - 'required' => false, - ], - 'required' => false, - ], - 'Body' => [ - 'description' => 'The custom body of a request to initiate an API performance synthetic monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'description' => 'The data type of the content.'."\n" + 'TaskId' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Name' => ['description' => 'The task name.'."\n", 'type' => 'string', 'example' => '拨测任务', 'title' => ''], + 'TaskType' => ['description' => 'The type of the task. Valid values:'."\n" ."\n" - .'* form-data'."\n" - .'* x-www-form-urlencoded'."\n" - .'* raw'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'form-data', - ], - 'FormData' => [ - 'description' => 'The data that is passed when the **Mode** parameter is set to **form-data**.'."\n", - 'type' => 'array', - 'items' => [ + .'1: ICMP. 2: TCP. 3: DNS. 4: HTTP. 5: website speed. 6: file download.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Url' => ['description' => 'The URL for synthetic monitoring.'."\n", 'type' => 'string', 'example' => 'https://www.example.com', 'title' => ''], + 'MonitorCategory' => ['description' => 'The detection point type. 1: PC. 2: mobile device.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Frequency' => ['description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.'."\n", 'type' => 'string', 'example' => '1m', 'title' => ''], + 'MonitorNum' => ['description' => 'The number of detection points.'."\n", 'type' => 'string', 'example' => '10', 'title' => ''], + 'Status' => ['description' => 'The task status. CREATING: The task is being created. RUNNING: The task is running. PARTIAL_RUNNING: The task is partially running. STOP: The task is stopped. LIMIT_STOP: The task is stopped due to quota limit. EXCEPTION: The task is abnormal. DELETE: The task is deleted. DELETE_EXCEPTION: An exception occurs while deleting the task.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'GmtCreate' => ['description' => 'The time when the task was created.'."\n", 'type' => 'string', 'example' => '1671454758000', 'title' => ''], + 'GmtModified' => ['description' => 'The time when the task was modified.'."\n", 'type' => 'string', 'example' => '1673085633000', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-aekzgwtq5vxxxxx', 'title' => ''], + 'CommonSetting' => [ + 'description' => 'The general settings.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of **form-data**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appId', + 'CustomHost' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The destination domain name.'."\n", 'type' => 'string', 'example' => 'www.aliyun.com', 'title' => ''], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4.'."\n" + .'* 2: IPv6.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'Ips' => [ + 'description' => 'The IP address.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'example' => '39.104.85.210', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'SelectType' => ['description' => 'The selection mode. Valid values:'."\n" + ."\n" + .'* 0: random'."\n" + .'* 1: polling'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'Value' => [ - 'description' => 'The value of **form-data**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '3425', + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4.'."\n" + .'* 2: IPv6.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'MonitorSamples' => ['description' => 'Indicates whether monitoring samples are evenly distributed. Valid values:'."\n" + ."\n" + .'* 0: No'."\n" + .'* 1: Yes'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'IsOpenTrace' => ['description' => 'Indicates whether tracing is enabled.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'TraceClientType' => ['description' => 'The type of the client for tracing. Valid values:'."\n" + ."\n" + .'* 0: ARMS agent'."\n" + .'* 1: OpenTelemetry'."\n" + .'* 2: Jaeger'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'XtraceRegion' => ['description' => 'The region to which trace data is reported.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'CustomVPCSetting' => [ + 'description' => 'The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-zhangjiakou', 'title' => ''], + 'VpcId' => ['description' => 'The VPC ID.'."\n", 'type' => 'string', 'example' => 'vpc-2zehbd4dfzahxxxxxxx', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'example' => 'vsw-bp1bcmj81kxxxxxxx', 'title' => ''], + 'SecureGroupId' => ['description' => 'The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.'."\n", 'type' => 'string', 'example' => 'sg-xxxxxxxxxxxxxx', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'CustomPrometheusSetting' => [ + 'description' => 'A reserved field.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => 'A reserved field.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'description' => 'A reserved field.'."\n", 'example' => '保留字段。'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PrometheusClusterId' => ['description' => 'A reserved field.'."\n", 'type' => 'string', 'example' => '保留字段。'."\n", 'title' => ''], + 'PrometheusClusterRegion' => ['description' => 'A reserved field.'."\n", 'type' => 'string', 'example' => '保留字段。', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'UrlEncoding' => [ - 'description' => 'The data that is passed when the **Mode** parameter is set to **x-www-form-urlencoded**.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of **x-www-form-urlencoded**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'appId', - ], - 'Value' => [ - 'description' => 'The value of **x-www-form-urlencoded**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '11080', + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'key', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'value', 'title' => ''], ], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], - 'required' => false, - ], - 'Raw' => [ - 'description' => 'The data that is passed when the **Mode** parameter is set to **raw**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'content', - ], - 'Language' => [ - 'description' => 'The language that is selected when the Mode parameter is set to raw.'."\n" - ."\n" - .'* json'."\n" - .'* xml'."\n" - .'* javascript'."\n" - .'* html'."\n" - .'* text'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'json', ], + 'title' => '', + 'example' => '', ], - 'required' => false, + 'title' => '', + 'example' => '', ], + 'Total' => ['description' => 'The total number of tasks.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '100', 'title' => ''], + 'Page' => ['description' => 'The page number.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], ], - 'required' => false, - ], - 'CharacterEncoding' => [ - 'description' => 'The encoding format.'."\n" - ."\n" - .'* 0: UTF-8'."\n" - .'* 1: GBK'."\n" - .'* 2: GB2312'."\n" - .'* 3: Unicode'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'VerifyWay' => [ - 'description' => 'The method that is used to verify the response content.'."\n" - ."\n" - .'* 0: no verification.'."\n" - .'* 1: exact match with the verification string.'."\n" - .'* 2: partial match with the verification string.'."\n" - .'* 3: MD5 verification.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], - 'VerifyContent' => [ - 'description' => 'The verification string.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"code":200', - ], - 'ReceivedDataSize' => [ - 'description' => 'The size of the received data. This parameter is required when you set the value of the VerifyWay parameter to 2.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '500', - ], - 'ProtocolMonitorTimeout' => [ - 'description' => 'The timeout period of API performance synthetic monitoring. Unit: seconds.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '30', - ], - 'CustomHost' => [ - 'description' => 'The custom host mode.'."\n" - ."\n" - .'* 1: round robin'."\n" - .'* 0: random'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], - 'CustomHostIp' => [ - 'description' => 'The custom host IP address. You can enter multiple IP addresses. Separate the IP addresses with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ipv4:192.168.2.1,192.168.2.5:img.a.com|192.168.2.1[8080]:img.a.com', - ], - 'ProtocolConnectionTime' => [ - 'description' => 'The connection timeout period of the protocol. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', + 'title' => '', + 'example' => '', ], ], - 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"730E90FE-996A-5638-99F3-4F0F9038CC6C\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"TaskId\\": \\"5308a2691f59422c8c3b7aeccec9cd3b\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Name\\": \\"拨测任务\\",\\n \\"TaskType\\": 1,\\n \\"Url\\": \\"https://www.example.com\\",\\n \\"MonitorCategory\\": 1,\\n \\"Frequency\\": \\"1m\\",\\n \\"MonitorNum\\": \\"10\\",\\n \\"Status\\": \\"RUNNING\\",\\n \\"GmtCreate\\": \\"1671454758000\\",\\n \\"GmtModified\\": \\"1673085633000\\",\\n \\"ResourceGroupId\\": \\"rg-aekzgwtq5vxxxxx\\",\\n \\"CommonSetting\\": {\\n \\"CustomHost\\": {\\n \\"Hosts\\": [\\n {\\n \\"Domain\\": \\"www.aliyun.com\\",\\n \\"IpType\\": 0,\\n \\"Ips\\": [\\n \\"39.104.85.210\\"\\n ]\\n }\\n ],\\n \\"SelectType\\": 0\\n },\\n \\"IpType\\": 0,\\n \\"MonitorSamples\\": 0,\\n \\"IsOpenTrace\\": false,\\n \\"TraceClientType\\": 1,\\n \\"XtraceRegion\\": \\"cn-hangzhou\\",\\n \\"CustomVPCSetting\\": {\\n \\"RegionId\\": \\"cn-zhangjiakou\\",\\n \\"VpcId\\": \\"vpc-2zehbd4dfzahxxxxxxx\\",\\n \\"VSwitchId\\": \\"vsw-bp1bcmj81kxxxxxxx\\",\\n \\"SecureGroupId\\": \\"sg-xxxxxxxxxxxxxx\\"\\n },\\n \\"CustomPrometheusSetting\\": {\\n \\"PrometheusLabels\\": {\\n \\"key\\": \\"保留字段。\\\\n\\"\\n },\\n \\"PrometheusClusterId\\": \\"保留字段。\\\\n\\",\\n \\"PrometheusClusterRegion\\": \\"保留字段。\\"\\n }\\n },\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"Total\\": 100,\\n \\"Page\\": 1,\\n \\"PageSize\\": 10\\n }\\n}","type":"json"}]', + 'title' => 'ListTimingSyntheticTasks', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'changeSet' => [ + ['createdAt' => '2024-04-12T06:35:24.000Z', 'description' => 'Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTimingSyntheticTasks'], + ], + ], + 'ramActions' => [], + ], + 'ListTraceApps' => [ + 'summary' => 'Queries all Application Monitoring tasks in a specified region.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'UpdateTask', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', 'in' => 'query', + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to update existing synthetic monitoring tasks.'."\n" - ."\n" - .'* true: updates existing synthetic monitoring tasks.'."\n" - .'* false: creates new synthetic monitoring tasks.'."\n", - 'type' => 'boolean', + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'false', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => false, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the application that is associated with the alert rule. Valid values:'."\n" + ."\n" + .'- TRACE: Application Monitoring'."\n" + .'- EBPF: Application Monitoring eBPF Edition', 'type' => 'string', 'required' => false, 'example' => 'TRACE', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n" - ."\n" - .'* 1001: The request was successful.'."\n" - .'* 1002: The request failed.'."\n" - .'* 1003: Parameter errors occurred.'."\n" - .'* 1004: Authentication failed.'."\n" - .'* 1006: The task does not exist.'."\n" - .'* 1099: Internal errors occurred.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'Msg' => [ - 'description' => 'The message that is returned when the task failed to be created.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Data' => [ - 'description' => 'The information about the synthetic monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* `2XX`: The request is successful.'."\n" + .'* `3XX`: A redirection message is returned.'."\n" + .'* `4XX`: The request is invalid.'."\n" + .'* `5XX`: A server error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request parameters are invalid.'."\n", 'type' => 'string', 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', 'title' => ''], + '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', 'title' => ''], + 'TraceApps' => [ + 'description' => 'The list of Application Monitoring tasks.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'* `TRACE`: Application Monitoring'."\n" + .'* `RETCODE`: Browser Monitoring'."\n", 'type' => 'string', 'example' => 'TRACE', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the monitoring task was updated. The value is a timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1529667762000', 'title' => ''], + 'Show' => ['description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the monitoring task was created. The value is a timestamp. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1529667762000', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'a5f9bdeb-2627-4dbe-9247-****', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Labels' => [ + 'description' => 'The labels of the application.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The value of the application label.'."\n", 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'The tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], + 'Source' => ['description' => 'The application source.'."\n", 'type' => 'string', 'example' => 'ACK', 'title' => ''], + 'WorkloadName' => ['description' => 'The name of the workload.', 'type' => 'string', 'example' => 'nginx-deployment ', 'title' => ''], + 'WorkloadKind' => ['description' => 'The type of the workload.', 'type' => 'string', 'example' => 'Deployment', 'title' => ''], + 'Namespace' => ['description' => 'The namespace.', 'type' => 'string', 'example' => 'default', 'title' => ''], + 'ClusterId' => ['description' => 'The cluster ID.', 'type' => 'string', 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], + 'Language' => ['description' => 'The language.', 'type' => 'string', 'example' => 'PHP', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": \\"1001\\",\\n \\"Msg\\": \\"null\\",\\n \\"Data\\": {\\n \\"TaskId\\": 1234\\n }\\n}","type":"json"}]', - 'title' => 'CreateSyntheticTask', - ], - 'GetSyntheticTaskMonitors' => [ - 'summary' => 'Obtains the information about synthetic monitoring points.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => '必选参数不能为空', 'description' => ''], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": 200,\\n \\"Message\\": \\"Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.\\",\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\",\\n \\"Success\\": true,\\n \\"TraceApps\\": [\\n {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"UpdateTime\\": 1529667762000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1529667762000,\\n \\"Pid\\": \\"a5f9bdeb-2627-4dbe-9247-****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"prod\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Source\\": \\"ACK\\",\\n \\"WorkloadName\\": \\"nginx-deployment \\",\\n \\"WorkloadKind\\": \\"Deployment\\",\\n \\"Namespace\\": \\"default\\",\\n \\"ClusterId\\": \\"cc7a37ee31aea4ed1a059eff8034b****\\",\\n \\"Language\\": \\"PHP\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListTraceAppsResponse>\\n\\t<TraceApps>\\n\\t\\t<Type>TRACE</Type>\\n\\t\\t<AppId>123</AppId>\\n\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t<CreateTime>1571865746000</CreateTime>\\n\\t\\t<UpdateTime>1571865746000</UpdateTime>\\n\\t\\t<Pid>a5f9bdeb-2627-4dbe-9247-****</Pid>\\n\\t\\t<Show>true</Show>\\n\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t<AppName>test-app</AppName>\\n\\t</TraceApps>\\n\\t<TraceApps>\\n\\t\\t<Type>TRACE</Type>\\n\\t\\t<AppId>234</AppId>\\n\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t<CreateTime>1572401289000</CreateTime>\\n\\t\\t<UpdateTime>1572401289000</UpdateTime>\\n\\t\\t<Pid>be1f9a33-9c8e-445e-9115-****</Pid>\\n\\t\\t<Show>true</Show>\\n\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t<AppName>test-app2</AppName>\\n\\t</TraceApps>\\n\\t<TraceApps>\\n\\t\\t<Type>TRACE</Type>\\n\\t\\t<AppId>345</AppId>\\n\\t\\t<UserId>113197164949****</UserId>\\n\\t\\t<CreateTime>1576338375000</CreateTime>\\n\\t\\t<UpdateTime>1576338375000</UpdateTime>\\n\\t\\t<Pid>e04391e2-a7e0-4fbe-9987****</Pid>\\n\\t\\t<Show>true</Show>\\n\\t\\t<RegionId>cn-hangzhou</RegionId>\\n\\t\\t<AppName>test-app3</AppName>\\n\\t</TraceApps>\\n\\t<RequestId>40B10E04-81E8-4643-970D-F1B38F2E****</RequestId>\\n\\t<Code>200</Code>\\n\\t<Success>true</Success>\\n</ListTraceAppsResponse>","errorExample":""}]', + 'title' => 'ListTraceApps', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-10-13T03:17:26.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-11T02:40:38.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-08-09T03:33:40.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-03T03:37:16.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-12-21T09:05:02.000Z', 'description' => 'Request parameters changed, Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'OpenArmsDefaultSLR' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region in which the application is located.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], - 'Code' => [ - 'description' => 'The status code returned.'."\n" - ."\n" - .'* 1001: The request was successful.'."\n" - .'* 1002: The request failed.'."\n" - .'* 1003: Parameter errors occurred.'."\n" - .'* 1004: Authentication failed.'."\n" - .'* 1006: The task does not exist.'."\n" - .'* 1099: Internal errors occurred.'."\n", - 'type' => 'string', - 'example' => '1001', - ], - 'Msg' => [ - 'description' => 'The message that is returned when the request failed.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Data' => [ - 'description' => 'The details of the monitoring point.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ClientType' => [ - 'description' => 'The client type:'."\n" - ."\n" - .'* 1: IDC'."\n" - .'* 2: Last mile'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CityCode' => [ - 'description' => 'The ID of the city to which the monitoring point belongs.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1100101', - ], - 'City' => [ - 'description' => 'The name of the city to which the monitoring point belongs.'."\n", - 'type' => 'string', - 'example' => 'Beijing'."\n", - ], - 'District' => [ - 'description' => 'The region to which the monitoring point belongs.'."\n", - 'type' => 'string', - 'example' => 'Beijing'."\n", - ], - 'NetServiceId' => [ - 'description' => 'The ID of the carrier.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '18', - ], - 'NetServiceName' => [ - 'description' => 'The name of the carrier.'."\n", - 'type' => 'string', - 'example' => 'XXX', - ], - 'Busy' => [ - 'description' => 'The task status.'."\n" - ."\n" - .'* 0: active'."\n" - .'* 1: busy'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - ], - ], - ], + 'Data' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '53CACA70-2CF7-490C-BD06-1A2AE4EB****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": \\"1001\\",\\n \\"Msg\\": \\"null\\",\\n \\"Data\\": [\\n {\\n \\"ClientType\\": 1,\\n \\"CityCode\\": 1100101,\\n \\"City\\": \\"北京市\\",\\n \\"District\\": \\"北京\\",\\n \\"NetServiceId\\": 18,\\n \\"NetServiceName\\": \\"XXX\\",\\n \\"Busy\\": 0\\n }\\n ]\\n}","type":"json"}]', - 'title' => 'GetSyntheticTaskMonitors', - ], - 'SwitchSyntheticTaskStatus' => [ - 'summary' => 'Starts or stops a scheduled synthetic monitoring task.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"53CACA70-2CF7-490C-BD06-1A2AE4EB****\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenArmsDefaultSLRResponse>\\n<RequestId>53CACA70-2CF7-490C-BD06-1A2AE4EB****</RequestId>\\n<Data>true</Data>\\n</OpenArmsDefaultSLRResponse>","errorExample":""}]', + 'title' => 'OpenArmsDefaultSLR', + 'summary' => 'Activates the service-linked role AliyunServiceRoleForARMS for Application Real-Time Monitoring Service (ARMS).', + 'changeSet' => [ + ['createdAt' => '2023-04-21T08:39:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'OpenArmsServiceSecondVersion' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'TaskIds', + 'name' => 'RegionId', 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The task IDs. You can specify up to 30 task IDs at a time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '16720', - ], - 'required' => false, - 'maxItems' => 30, - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SwitchStatus', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to start or stop the task. Valid values:'."\n" - ."\n" - .'* **0**: stops the task'."\n" - .'* **1**: starts the task'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The type of the service. Valid values:'."\n" + ."\n" + .'* `arms`: ARMS'."\n" + .'* `arms_app`: Application Monitoring'."\n" + .'* `arms_web`: Browser Monitoring'."\n" + .'* `prometheus_monitor`: Managed Service for Prometheus'."\n" + .'* `synthetic_post`: Synthetic Monitoring'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Result' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'OrderId' => ['description' => 'The service ID returned if the service is activated.'."\n", 'type' => 'string', 'example' => '20896874992****', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '9ED50893-F3C4-42DF-ABB2-C200BE******', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'SwitchSyntheticTaskStatus', - ], - 'GetSyntheticTaskList' => [ - 'summary' => 'Queries a list of scheduled synthetic monitoring tasks.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', 'errorMessage' => '用户可用余额小于0，请充值后再次尝试开通。', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20896874992****\\",\\n \\"RequestId\\": \\"9ED50893-F3C4-42DF-ABB2-C200BE******\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenArmsServiceSecondVersionResponse>\\n <OrderId>20896874992****</OrderId>\\n <RequestId>9ED50893-F3C4-42DF-ABB2-C200BE******</RequestId>\\n</OpenArmsServiceSecondVersionResponse>","errorExample":""}]', + 'title' => 'OpenArmsServiceSecondVersion', + 'summary' => 'Activates a specified pay-as-you-go sub-service of Application Real-Time Monitoring Service (ARMS).', + 'description' => 'The **OpenArmsServiceSecondVersion** operation supports the following sub-service editions:'."\n" + ."\n" + .'* Application Monitoring: Basic Edition'."\n" + .'* Browser Monitoring: Basic Edition'."\n" + .'* Synthetic Monitoring: Pro Edition (pay-as-you-go)'."\n" + .'* Prometheus Service: Pro Edition'."\n", + 'changeSet' => [ + ['createdAt' => '2023-09-25T06:46:19.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-03-27T11:01:50.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-11-01T11:42:09.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenArmsServiceSecondVersion'], + ], ], + 'ramActions' => [], + ], + 'OpenVCluster' => [ + 'summary' => 'Activates a virtual cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: **cn-hangzhou**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TaskType', + 'name' => 'ClusterType', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'1. 3: web page performance - IE'."\n" - .'2. 34: web page performance - Chrome'."\n" - .'3. 0: network quality'."\n" - .'4. 40: file download'."\n" - .'5. 7: API performance'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '0', - ], + 'schema' => ['description' => 'The type of the cluster. For cloud services, set this parameter to `cloud-product-prometheus`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cloud-product-prometheus', 'title' => ''], ], [ - 'name' => 'Url', + 'name' => 'Length', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL for synthetic monitoring.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://www.example.com'."\n", - ], + 'schema' => ['description' => 'The length of the cluster ID. Default value: 10.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'TaskName', + 'name' => 'Product', 'in' => 'query', - 'schema' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'net-test', - ], + 'schema' => ['description' => 'The name of the cloud service. This parameter must be specified when ClusterType is set to `cloud-product-prometheus`. Valid values: influxdb, mongodb, and DLA. You cannot specify multiple service names.'."\n", 'type' => 'string', 'required' => false, 'example' => 'influxdb', 'title' => ''], ], [ - 'name' => 'TaskStatus', + 'name' => 'RecreateSwitch', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* **0**: The task is stopped.'."\n" - .'* **1**: The task is started.'."\n" - .'* **9**: The task is ended.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1', - ], + 'schema' => ['description' => 'Specifies whether to create or query a virtual cluster. This parameter provides backward compatibility.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], - [ - 'name' => 'PageNum', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'example' => 'rre59xelcx', 'title' => ''], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '42E58E4D-ACAD-4400-8FAF-F762340AE5B3', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10', - ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"rre59xelcx\\",\\n \\"RequestId\\": \\"42E58E4D-ACAD-4400-8FAF-F762340AE5B3\\"\\n}","type":"json"}]', + 'title' => 'OpenVCluster', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenVCluster'], ], + ], + 'ramActions' => [], + ], + 'OpenXtraceDefaultSLR' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The condition by which the queried tasks are sorted.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CreateTime', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'Direction', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The order by which the queried tasks are sorted. Valid values:'."\n" - ."\n" - .'* **asc**: ascending'."\n" - .'* **desc**: descending'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'asc', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'PageInfo' => [ - 'description' => 'The query results.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'List' => [ - 'description' => 'The task information.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the scheduled task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'example' => '2118709', - ], - 'TaskName' => [ - 'description' => 'The task name.'."\n", - 'type' => 'string', - 'example' => 'net-test', - ], - 'Url' => [ - 'description' => 'The URL for synthetic monitoring.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - ], - 'TaskType' => [ - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'1. 3: web page performance - IE'."\n" - .'2. 34: web page performance - Chrome'."\n" - .'3. 0: network quality'."\n" - .'4. 40: file download'."\n" - .'5. 7: API performance'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'TaskTypeName' => [ - 'description' => 'The name of the task type.'."\n", - 'type' => 'string', - 'example' => '', - ], - 'MonitorNumber' => [ - 'description' => 'The number of detection points.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2', - ], - 'TaskStatus' => [ - 'description' => 'The status of the task. Valid values:'."\n" - ."\n" - .'* **0**: The task is stopped.'."\n" - .'* **1**: The task is started.'."\n" - .'* **9**: The task is ended.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Usable' => [ - 'description' => 'The availability. Only the data of the last day is counted. If no data is available for the last day, an empty value is returned.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '0.80', - ], - 'CreateTime' => [ - 'description' => 'The time when the task was created.'."\n", - 'type' => 'string', - 'example' => '1634005438000', - ], - ], - ], - ], - 'Size' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Pages' => [ - 'description' => 'The total number of pages returned.'."\n", - 'type' => 'string', - 'example' => '10', - ], - 'Prepage' => [ - 'description' => 'The previous page.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'NextPage' => [ - 'description' => 'The next page.'."\n", - 'type' => 'string', - 'example' => '3', - ], - 'IsFirstPage' => [ - 'description' => 'Indicates whether the page is the first page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'IsLastPage' => [ - 'description' => 'Indicates whether the page is the last page.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HasPreviousPage' => [ - 'description' => 'Indicates whether a previous page exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'HasNextPage' => [ - 'description' => 'Indicates whether the current page is followed by a page.'."\n", - 'type' => 'string', - 'example' => 'false', - ], - 'NavigatePageNums' => [ - 'description' => 'All navigation page numbers.'."\n", - 'type' => 'string', - 'example' => '1,2,3', - ], - 'NavigateFirstPage' => [ - 'description' => 'The first page on the navigation bar.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'NavigateLastPage' => [ - 'description' => 'The last page on the navigation bar.'."\n", - 'type' => 'string', - 'example' => '3', - ], - ], - ], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + .' '."\n" + .'* `true`'."\n" + .'* `false`', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '53CACA70-2CF7-490C-BD06-1A2AE4EB****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"PageInfo\\": {\\n \\"Total\\": 15,\\n \\"List\\": [\\n {\\n \\"TaskId\\": \\"2118709\\",\\n \\"TaskName\\": \\"net-test\\",\\n \\"Url\\": \\"www.example.com\\",\\n \\"TaskType\\": 0,\\n \\"TaskTypeName\\": \\"网络质量\\",\\n \\"MonitorNumber\\": 2,\\n \\"TaskStatus\\": \\"0\\",\\n \\"Usable\\": 0.8,\\n \\"CreateTime\\": \\"1634005438000\\"\\n }\\n ],\\n \\"Size\\": 10,\\n \\"Pages\\": \\"10\\",\\n \\"Prepage\\": \\"1\\",\\n \\"NextPage\\": \\"3\\",\\n \\"IsFirstPage\\": true,\\n \\"IsLastPage\\": true,\\n \\"HasPreviousPage\\": true,\\n \\"HasNextPage\\": \\"false\\",\\n \\"NavigatePageNums\\": \\"1,2,3\\",\\n \\"NavigateFirstPage\\": \\"1\\",\\n \\"NavigateLastPage\\": \\"3\\"\\n }\\n}","type":"json"}]', - 'title' => 'GetSyntheticTaskList', - ], - 'GetSyntheticTaskDetail' => [ - 'summary' => 'Queries the details of a scheduled synthetic monitoring task.', - 'methods' => [ - 'post', - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"53CACA70-2CF7-490C-BD06-1A2AE4EB****\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenXtraceDefaultSLRResponse>\\n<RequestId>53CACA70-2CF7-490C-BD06-1A2AE4EB****</RequestId>\\n<Data>true</Data>\\n</OpenXtraceDefaultSLRResponse>","errorExample":""}]', + 'title' => 'OpenXtraceDefaultSLR', + 'summary' => 'Activates the service-linked role AliyunServiceRoleForXtrace for Tracing Analysis.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-01-17T02:20:44.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryAppMetadata' => [ + 'summary' => 'Queries application metadata by ID and type.', + 'methods' => ['get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'MetaIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The metadata IDs. Use a comma (,) to separate multiple IDs.'."\n" + ."\n" + .'You can obtain the exception ID on the **exception analysis** page of the target application in the ARMS console.', 'type' => 'string', 'required' => true, 'example' => '4c9dd447,3c76c565', 'title' => ''], ], [ - 'name' => 'TaskId', + 'name' => 'MetaType', 'in' => 'query', 'schema' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", + 'description' => 'The type of the metadata. Valid values:'."\n" + ."\n" + .'- sql: Retrieves the SQL statement by sqlId.'."\n" + ."\n" + .'- exception: Retrieves the exception stack by exceptionId.', + 'enumValueTitles' => ['exception' => 'exception', 'sql' => 'sql'], 'type' => 'string', 'required' => true, - 'example' => '123', + 'example' => 'sql', + 'title' => '', ], ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The application ID. To obtain the ID, call the **ListTraceApps** operation.', 'type' => 'string', 'required' => true, 'example' => 'ggxw4lnjuz@54364d85b******', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'StartTimeMs', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], + [ + 'name' => 'EndTimeMs', + 'in' => 'query', + 'schema' => ['type' => 'integer', 'format' => 'int64', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], - 'TaskDetail' => [ - 'description' => 'The details of the task.'."\n", - 'type' => 'object', - 'properties' => [ - 'TaskId' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '19584', - ], - 'TaskName' => [ - 'description' => 'The name of the task.'."\n", - 'type' => 'string', - 'example' => 'net-test', - ], - 'Url' => [ - 'description' => 'The URL for synthetic monitoring.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - ], - 'MonitorList' => [ - 'description' => 'The detection points.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'CityCode' => [ - 'description' => 'The city code.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '110100', - ], - 'NetServiceId' => [ - 'description' => 'The ID of the network service.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12001', - ], - 'MonitorType' => [ - 'description' => 'The type of the detection point.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'IDC', - ], - 'SendCount' => [ - 'description' => 'The number of times that the system sends detection requests.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - 'description' => '', - ], - ], - 'TaskType' => [ - 'description' => 'The type of the task. Valid values:'."\n" - ."\n" - .'1. 3: web page performance - IE'."\n" - .'2. 34: web page performance - Chrome'."\n" - .'3. 0: network quality'."\n" - .'4. 40: file download'."\n" - .'5. 7: API performance'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'IntervalTime' => [ - 'description' => 'The interval at which synthetic monitoring is performed. Unit: minutes. Valid values:'."\n" - ."\n" - .'* 1'."\n" - .'* 5'."\n" - .'* 10'."\n" - .'* 15'."\n" - .'* 20'."\n" - .'* 30'."\n" - .'* 60'."\n" - .'* 120'."\n" - .'* 180'."\n" - .'* 240'."\n" - .'* 360'."\n" - .'* 480'."\n" - .'* 720'."\n" - .'* 1440'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'IntervalType' => [ - 'description' => 'The interval type. Valid values:'."\n" - ."\n" - .'* 0: daily'."\n" - .'* 1: custom frequency'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ExtendInterval' => [ - 'description' => 'The frequency.'."\n", - 'type' => 'object', - 'properties' => [ - 'StartTime' => [ - 'description' => 'The time when synthetic monitoring starts. Format: yyyy-MM-dd HH.'."\n", - 'type' => 'string', - 'example' => '2022-02-26 11:40', - ], - 'EndTime' => [ - 'description' => 'The time when synthetic monitoring ends. Format: `yyyy-MM-dd HH`.'."\n", - 'type' => 'string', - 'example' => '2022-05-03 11:40', - ], - 'Days' => [ - 'description' => 'The day on which synthetic monitoring is performed. Valid values:'."\n" - ."\n" - .'* \\-1: every day'."\n" - .'* 0: Sunday'."\n" - .'* 1: Monday'."\n" - .'* 2: Tuesday'."\n" - .'* 3: Wednesday'."\n" - .'* 4: Thursday'."\n" - .'* 5: Friday'."\n" - .'* 6: Saturday'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The day on which synthetic monitoring is performed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - ], - 'StartHour' => [ - 'description' => 'The hour at which synthetic monitoring starts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '9', - ], - 'StartMinute' => [ - 'description' => 'The minute at which synthetic monitoring starts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Endhour' => [ - 'description' => 'The hour at which synthetic monitoring ends.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'EndMinute' => [ - 'description' => 'The minute at which synthetic monitoring ends.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - ], - ], - 'IpType' => [ - 'description' => 'The IP version. Valid values:'."\n" - ."\n" - .'* 0: A version is automatically selected.'."\n" - .'* 1: IPv4.'."\n" - .'* 2: IPv6.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'Download' => [ - 'description' => 'The file download task.'."\n", - 'type' => 'object', - 'properties' => [ - 'DownloadTransmissionSize' => [ - 'description' => 'The file size. Unit: KB.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'DownloadCustomHost' => [ - 'description' => 'The custom host. Valid values:'."\n" - ."\n" - .'* 1: round robin'."\n" - .'* 0: random'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DownloadCustomHostIp' => [ - 'description' => 'The custom IP address of the host. Multiple IP addresses are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '168.23.45.1', - ], - 'WhiteList' => [ - 'description' => 'The whitelisted objects that are used to avoid DNS hijacking. Format: `<domain name>:<objects>`.'."\n" - ."\n" - .'> WAP networks do not support hijacking.'."\n", - 'type' => 'string', - 'example' => '[{\\"src\\":\\"211.154.166.174\\"}]', - ], - 'DownloadKernel' => [ - 'description' => 'The kernel type. Valid values:'."\n" - ."\n" - .'* 1: curl'."\n" - .'* 0: WinInet'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'QuickProtocol' => [ - 'description' => 'The QUIC protocol type. Valid values:'."\n" - ."\n" - .'* 1: HTTP/1'."\n" - .'* 2: HTTP/2'."\n" - .'* 3: http3'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring duration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'ConnectionTimeout' => [ - 'description' => 'The timeout period of the file download task.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'VerifyWay' => [ - 'description' => 'The method that is used to verify the response content. Valid values:'."\n" - ."\n" - .'* 0: no verification.'."\n" - .'* 1: exact match with the verification string.'."\n" - .'* 2: partial match with the verification string.'."\n" - .'* 3: MD5 verification.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'ValidateKeywords' => [ - 'description' => 'The keyword that is used in verification.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'DownloadRedirect' => [ - 'description' => 'Indicates whether redirection is supported.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'DownloadCustomHeaderContent' => [ - 'description' => 'The items to be ignored in a certificate error. Multiple values are concatenated with vertical bars (|).'."\n", - 'type' => 'string', - 'example' => 'char', - ], - ], - ], - 'Net' => [ - 'description' => 'The network synthetic monitoring task.'."\n", - 'type' => 'object', - 'properties' => [ - 'NetIcmpSwitch' => [ - 'description' => 'Indicates whether ICMP test is enabled. Valid values:'."\n" - ."\n" - .'* 0: no.'."\n" - .'* 1: yes. If you set this parameter to 1, you must also set the Icmp parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetIcmpActive' => [ - 'description' => 'The protocol type. Valid values:'."\n" - ."\n" - .'* 0 : ICMP'."\n" - .'* 1 : TCP'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetIcmpTimeout' => [ - 'description' => 'The monitoring timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'NetIcmpInterval' => [ - 'description' => 'The interval at which the synthetic monitoring task is executed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'NetIcmpNum' => [ - 'description' => 'The number of packets.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'NetIcmpSize' => [ - 'description' => 'The packet size.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'NetIcmpDataCut' => [ - 'description' => 'Indicates whether packets are split. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetDnsQueryMethod' => [ - 'description' => 'The DNS query method. Valid values:'."\n" - ."\n" - .'* 1: recursive'."\n" - .'* 2: iterative'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'NetDnsSwitch' => [ - 'description' => 'Indicates whether DNS test is enabled. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetTraceRouteSwitch' => [ - 'description' => 'Indicates whether Tracert test is enabled. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes. If you set this parameter to 1, you must also set the Tracert parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetTraceRouteTimeout' => [ - 'description' => 'The monitoring timeout period. Valid values: 0 to 300. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'NetTraceRouteNum' => [ - 'description' => 'The maximum number of active detection points.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'WhiteList' => [ - 'description' => 'The whitelisted objects that are used to avoid DNS hijacking. Format: `<domain name>:<objects>`.'."\n" - ."\n" - .'> WAP networks do not support hijacking.'."\n", - 'type' => 'string', - 'example' => '119.119.53.156/32', - ], - 'NetDnsNs' => [ - 'description' => 'The NS server.'."\n", - 'type' => 'string', - 'example' => '189.12.32.124', - ], - 'NetDigSwitch' => [ - 'description' => 'Indicates whether the data is displayed in the DIG format. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetDnsServer' => [ - 'description' => 'The type of the DNS server. Valid values:'."\n" - ."\n" - .'* 0: ipv4'."\n" - .'* 1: ipv6'."\n" - .'* 2: A version is automatically selected.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NetDnsTimeout' => [ - 'description' => 'The timeout period of DNS requests.'."\n", - 'type' => 'string', - 'example' => '10', - ], - ], - ], - 'Nav' => [ - 'description' => 'The browser test task.'."\n", - 'type' => 'object', - 'properties' => [ - 'NavDisableCache' => [ - 'description' => 'Indicates whether caching is disabled. Valid values:'."\n" - ."\n" - .'* 1: Caching is disabled.'."\n" - .'* 0: Caching is enabled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NavReturnElement' => [ - 'description' => 'Indicates whether the elements on the page are returned.'."\n" - ."\n" - .'* 1: no. The basic document data is returned.'."\n" - .'* 2: yes. All document data is returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NavRedirect' => [ - 'description' => 'Indicates whether redirection is enabled. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NavDisableCompression' => [ - 'description' => 'Indicates whether compression is disabled. Valid values:'."\n" - ."\n" - .'* 0: Compression is enabled.'."\n" - .'* 1: Compression is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NavAutomaticScrolling' => [ - 'description' => 'Indicates whether the screen is automatically scrolled up and down to load a page. Valid values:'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NavIgnoreCertificateError' => [ - 'description' => 'Indicates whether certificate errors are ignored during certificate verification in the SSL handshake. Valid values:'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'FilterInvalidIP' => [ - 'description' => 'Indicates whether invalid IP addresses are excluded. Valid values:'."\n" - ."\n" - .'* 1: no'."\n" - .'* 0: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecuteApplet' => [ - 'description' => 'Indicates whether the applet is executed. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: yes'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'ExecuteActiveX' => [ - 'description' => 'Indicates whether ActiveX is executed. Valid values:'."\n" - ."\n" - .'* 3: yes'."\n" - .'* 0: no'."\n" - ."\n" - .'> Only IE elements support this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'ExecuteScript' => [ - 'description' => 'Indicates whether scripts are executed. Valid values:'."\n" - ."\n" - .'* 1: yes'."\n" - .'* 0: no'."\n" - ."\n" - .'> Only IE elements support this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'QuicVersion' => [ - 'description' => 'The QUIC version. Default value: 0. Valid values:'."\n" - ."\n" - .'* 35'."\n" - .'* 39'."\n" - .'* 43'."\n" - .'* 44'."\n" - ."\n" - .'> Only Chrome elements support this parameter.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'QuicDomain' => [ - 'description' => 'The domain name of the QUIC request element.'."\n", - 'type' => 'string', - 'example' => 'www.example.com', - ], - 'RequestHeader' => [ - 'description' => 'Indicates whether request headers are returned. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: The headers of base documents are returned.'."\n" - .'* 2: All headers are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'NavCustomHost' => [ - 'description' => 'The custom host mode. Valid values:'."\n" - ."\n" - .'* 1: round robin'."\n" - .'* 0: random'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'NavCustomHostIp' => [ - 'description' => 'The custom IP address of the host. Multiple IP addresses are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '119.119.53.156/32'."\n", - ], - 'NavCustomHeader' => [ - 'description' => 'Indicates whether a custom header is created. Valid values:'."\n" - ."\n" - .'* 0: no'."\n" - .'* 1: A custom header is created for the first packet.'."\n" - .'* 2: A custom header is created for all packets.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'NavCustomHeaderContent' => [ - 'description' => 'The format of the custom header. Multiple fields are separated with vertical bars (|).'."\n", - 'type' => 'string', - 'example' => 'content', - ], - 'ElementBlacklist' => [ - 'description' => 'The element blacklist.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'ProcessName' => [ - 'description' => 'The process ID.'."\n", - 'type' => 'string', - 'example' => 'ssh', - ], - 'VerifyStringBlacklist' => [ - 'description' => 'The blacklist for string verification.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'VerifyStringWhitelist' => [ - 'description' => 'The whitelist for string verification.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'MonitorTimeout' => [ - 'description' => 'The monitoring timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'WaitCompletionTime' => [ - 'description' => 'The timeout period of waiting for the monitoring to complete.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'SlowElementThreshold' => [ - 'description' => 'The time threshold that is used to define a slow element. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'DnsHijackWhitelist' => [ - 'description' => 'The DNS whitelist.'."\n", - 'type' => 'string', - 'example' => '119.119.53.156', - ], - 'PageTampering' => [ - 'description' => 'The page tampering.'."\n", - 'type' => 'string', - 'example' => 'content', - ], - 'FlowHijackJumpTimes' => [ - 'description' => 'The element that is used in DNS hijacking.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12', - ], - 'FlowHijackLogo' => [ - 'description' => 'The tag that is used in DNS hijacking.'."\n", - 'type' => 'string', - 'example' => 'target', - ], - ], - ], - 'Protocol' => [ - 'description' => 'The synthetic monitoring task of the API performance type.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestContent' => [ - 'description' => 'The request content, including the header and body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'description' => 'The request method. Valid values:'."\n" - ."\n" - .'* POST'."\n" - .'* GET'."\n", - 'type' => 'string', - 'example' => 'POST', - ], - 'Header' => [ - 'description' => 'The request header.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The header information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the header in the request parameters.'."\n", - 'type' => 'string', - 'example' => 'regionId', - ], - 'Value' => [ - 'description' => 'The value of the header in the request parameters.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], - ], - 'Body' => [ - 'description' => 'The content of the request body.'."\n", - 'type' => 'object', - 'properties' => [ - 'Mode' => [ - 'description' => 'The type of the content. Valid values:'."\n" - ."\n" - .'* form-data'."\n" - .'* x-www-form-urlencoded'."\n" - .'* raw'."\n", - 'type' => 'string', - 'example' => 'form-data', - ], - 'Formdata' => [ - 'description' => 'The data content. This parameter is returned when Mode is set to form-data.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the **form-data**.'."\n", - 'type' => 'string', - 'example' => 'appId', - ], - 'Value' => [ - 'description' => 'The value of the form-data.'."\n", - 'type' => 'string', - 'example' => '3425', - ], - ], - ], - 'Urlencoded' => [ - 'description' => 'The URL of the body content.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'appId', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => '11080', - ], - ], - ], - 'Raw' => [ - 'description' => 'The data content. This parameter is returned when **Mode** is set to **raw**.'."\n", - 'type' => 'string', - 'example' => 'content', - ], - 'Language' => [ - 'description' => 'The language used when Mode is set to raw. Valid values:'."\n" - ."\n" - .'* json'."\n" - .'* xml'."\n" - .'* javascript'."\n" - .'* html'."\n" - .'* text'."\n", - 'type' => 'string', - 'example' => 'xml', - ], - ], - ], - ], - ], - 'CharacterEncoding' => [ - 'description' => 'The encoding format. Valid values:'."\n" - ."\n" - .'* 0: UTF-8'."\n" - .'* 1: GBK'."\n" - .'* 2: GB2312'."\n" - .'* 3: Unicode'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'VerifyWay' => [ - 'description' => 'The method that is used to verify the response content. Valid values:'."\n" - ."\n" - .'* 0: no verification.'."\n" - .'* 1: exact match with the verification string.'."\n" - .'* 2: partial match with the verification string.'."\n" - .'* 3: MD5 verification.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'VerifyContent' => [ - 'description' => 'The verification string.'."\n", - 'type' => 'string', - 'example' => 'list', - ], - 'ReceivedDataSize' => [ - 'description' => 'The size of the received data. This parameter is returned when **VerifyWay** is set to 2.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'ProtocolMonitorTimeout' => [ - 'description' => 'The timeout period of API performance monitoring. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - 'ProtocolConnectionTimeout' => [ - 'description' => 'The timeout period.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'CustomHost' => [ - 'description' => 'The custom host. Valid values:'."\n" - ."\n" - .'* 1: round robin'."\n" - .'* 0: random'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'CustomHostIp' => [ - 'description' => 'The custom IP address of the host. Multiple IP addresses are separated with commas (,).'."\n", - 'type' => 'string', - 'example' => '119.119.53.156', - ], - ], - ], - 'MonitorListString' => [ - 'description' => 'The detection points.'."\n", - 'type' => 'string', - 'example' => '12', - ], - 'CommonParam' => [ - 'description' => 'The list of common parameters.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlarmFlag' => [ - 'description' => 'The identifier of the alert.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'AlertPolicyId' => [ - 'description' => 'The ID of the alert policy.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'AlertNotifierId' => [ - 'description' => 'The ID of the alert identifier.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'StartExecutionTime' => [ - 'description' => 'The start time of the execution.'."\n", - 'type' => 'string', - 'example' => '1664427128', - ], - 'MonitorSamples' => [ - 'description' => 'The monitoring samples.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'AlertList' => [ - 'description' => 'The list of alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The alert name.'."\n", - 'type' => 'string', - 'example' => 'alert-test', - ], - 'GeneralAlert' => [ - 'description' => 'The low-risk alert.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'SeriousAlert' => [ - 'description' => 'The Critical-level alert.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'IsCritical' => [ - 'description' => 'Indicates whether the condition is essential.'."\n", - 'type' => 'string', - 'example' => '0', - ], - 'Symbols' => [ - 'description' => 'Greater than or less than.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - 'description' => '', - ], - ], - ], - ], - ], - ], + 'title' => '', + 'description' => 'The response object.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '51877BAC-330C-5845-BDFD-C7859AD33FB7'], + 'Data' => ['description' => 'The returned object.', 'type' => 'object', 'example' => '{\'408d5533\': \'SELECT * FROM user_base_info\'}', 'title' => ''], + 'Code' => ['description' => 'The API call status.'."\n" + ."\n" + .'- 2xx: The request was successful.'."\n" + ."\n" + .'- 3xx: The request was redirected.'."\n" + ."\n" + .'- 4xx: A client-side error occurred.'."\n" + ."\n" + .'- 5xx: A server-side error occurred.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the query was successful.'."\n" + ."\n" + .'- `true`: The query was successful.'."\n" + ."\n" + .'- `false`: The query failed.', 'type' => 'boolean', 'example' => 'True', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"TaskDetail\\": {\\n \\"TaskId\\": 19584,\\n \\"TaskName\\": \\"net-test\\",\\n \\"Url\\": \\"www.example.com\\",\\n \\"MonitorList\\": [\\n {\\n \\"CityCode\\": 0,\\n \\"NetServiceId\\": 12,\\n \\"MonitorType\\": 1,\\n \\"SendCount\\": 2\\n }\\n ],\\n \\"TaskType\\": 0,\\n \\"IntervalTime\\": 20,\\n \\"IntervalType\\": 0,\\n \\"ExtendInterval\\": {\\n \\"StartTime\\": \\"2022-02-26 11:40\\",\\n \\"EndTime\\": \\"2022-05-03 11:40\\",\\n \\"Days\\": [\\n 3\\n ],\\n \\"StartHour\\": 9,\\n \\"StartMinute\\": 20,\\n \\"Endhour\\": 12,\\n \\"EndMinute\\": 20\\n },\\n \\"IpType\\": 0,\\n \\"Download\\": {\\n \\"DownloadTransmissionSize\\": 20,\\n \\"DownloadCustomHost\\": 0,\\n \\"DownloadCustomHostIp\\": \\"168.23.45.1\\",\\n \\"WhiteList\\": \\"[{\\\\\\\\\\\\\\"src\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"211.154.166.174\\\\\\\\\\\\\\"}]\\",\\n \\"DownloadKernel\\": 1,\\n \\"QuickProtocol\\": \\"1\\",\\n \\"MonitorTimeout\\": 12,\\n \\"ConnectionTimeout\\": 200,\\n \\"VerifyWay\\": 0,\\n \\"ValidateKeywords\\": \\"test\\",\\n \\"DownloadRedirect\\": 1,\\n \\"DownloadCustomHeaderContent\\": \\"char\\"\\n },\\n \\"Net\\": {\\n \\"NetIcmpSwitch\\": 0,\\n \\"NetIcmpActive\\": 0,\\n \\"NetIcmpTimeout\\": 20,\\n \\"NetIcmpInterval\\": 10,\\n \\"NetIcmpNum\\": 10,\\n \\"NetIcmpSize\\": 30,\\n \\"NetIcmpDataCut\\": 0,\\n \\"NetDnsQueryMethod\\": \\"1\\",\\n \\"NetDnsSwitch\\": 0,\\n \\"NetTraceRouteSwitch\\": 0,\\n \\"NetTraceRouteTimeout\\": 20,\\n \\"NetTraceRouteNum\\": 30,\\n \\"WhiteList\\": \\"119.119.53.156/32\\",\\n \\"NetDnsNs\\": \\"189.12.32.124\\",\\n \\"NetDigSwitch\\": 0,\\n \\"NetDnsServer\\": 0,\\n \\"NetDnsTimeout\\": \\"10\\"\\n },\\n \\"Nav\\": {\\n \\"NavDisableCache\\": 1,\\n \\"NavReturnElement\\": 1,\\n \\"NavRedirect\\": 1,\\n \\"NavDisableCompression\\": 0,\\n \\"NavAutomaticScrolling\\": 1,\\n \\"NavIgnoreCertificateError\\": 1,\\n \\"FilterInvalidIP\\": 1,\\n \\"ExecuteApplet\\": 1,\\n \\"ExecuteActiveX\\": 3,\\n \\"ExecuteScript\\": 1,\\n \\"QuicVersion\\": 0,\\n \\"QuicDomain\\": \\"www.example.com\\",\\n \\"RequestHeader\\": 0,\\n \\"NavCustomHost\\": 1,\\n \\"NavCustomHostIp\\": \\"119.119.53.156/32\\",\\n \\"NavCustomHeader\\": \\"0\\",\\n \\"NavCustomHeaderContent\\": \\"content\\",\\n \\"ElementBlacklist\\": \\"test\\",\\n \\"ProcessName\\": \\"ssh\\",\\n \\"VerifyStringBlacklist\\": \\"test\\",\\n \\"VerifyStringWhitelist\\": \\"test\\",\\n \\"MonitorTimeout\\": 20,\\n \\"WaitCompletionTime\\": 20,\\n \\"SlowElementThreshold\\": 30,\\n \\"DnsHijackWhitelist\\": \\"119.119.53.156\\",\\n \\"PageTampering\\": \\"content\\",\\n \\"FlowHijackJumpTimes\\": 12,\\n \\"FlowHijackLogo\\": \\"target\\"\\n },\\n \\"Protocol\\": {\\n \\"RequestContent\\": {\\n \\"Method\\": \\"POST\\",\\n \\"Header\\": [\\n {\\n \\"Key\\": \\"regionId\\",\\n \\"Value\\": \\"cn-hangzhou\\"\\n }\\n ],\\n \\"Body\\": {\\n \\"Mode\\": \\"form-data\\",\\n \\"Formdata\\": {\\n \\"Key\\": \\"appId\\",\\n \\"Value\\": \\"3425\\"\\n },\\n \\"Urlencoded\\": {\\n \\"Key\\": \\"appId\\",\\n \\"Value\\": \\"11080\\"\\n },\\n \\"Raw\\": \\"content\\",\\n \\"Language\\": \\"xml\\"\\n }\\n },\\n \\"CharacterEncoding\\": 0,\\n \\"VerifyWay\\": 0,\\n \\"VerifyContent\\": \\"list\\",\\n \\"ReceivedDataSize\\": 30,\\n \\"ProtocolMonitorTimeout\\": 30,\\n \\"ProtocolConnectionTimeout\\": 20,\\n \\"CustomHost\\": 1,\\n \\"CustomHostIp\\": \\"119.119.53.156\\"\\n },\\n \\"MonitorListString\\": \\"12\\",\\n \\"CommonParam\\": {\\n \\"AlarmFlag\\": 1,\\n \\"AlertPolicyId\\": \\"1\\",\\n \\"AlertNotifierId\\": \\"1\\",\\n \\"StartExecutionTime\\": \\"1664427128\\",\\n \\"MonitorSamples\\": \\"1\\",\\n \\"AlertList\\": [\\n {\\n \\"Name\\": \\"alert-test\\",\\n \\"GeneralAlert\\": \\"1\\",\\n \\"SeriousAlert\\": \\"1\\",\\n \\"IsCritical\\": \\"0\\",\\n \\"Symbols\\": \\"1\\"\\n }\\n ]\\n }\\n }\\n}","type":"json"}]', - 'title' => 'GetSyntheticTaskDetail', - ], - 'DeleteSyntheticTask' => [ - 'summary' => 'Deletes scheduled synthetic monitoring tasks.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'QueryAppMetadata', + 'changeSet' => [ + ['createdAt' => '2025-09-23T08:15:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-21T09:50:30.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAppMetadata'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:QueryAppMetadata', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"51877BAC-330C-5845-BDFD-C7859AD33FB7\\",\\n \\"Data\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200,\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'QueryAppTopology' => [ + 'summary' => 'Queries the topology of an application.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], ], ], + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the application.'."\n" + ."\n" + .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with an at sign (@) to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.'."\n", 'type' => 'string', 'required' => false, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => ['description' => 'The application type', 'type' => 'string', 'required' => false, 'example' => 'TRACE', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", + 'description' => 'The type kind of topology.', 'type' => 'string', 'required' => true, - 'example' => 'cn-hangzhou', + 'enumValueTitles' => ['apm_txn' => '', 'apm_app_v2' => '', 'apm_database_v2' => '', 'apm_apps' => '', 'apm_app' => '', 'apm_txn_v2' => '', 'apm_database' => '', 'apm_apps_v2' => ''], + 'example' => 'apm_apps_v2', + 'title' => '', ], ], [ - 'name' => 'TaskIds', + 'name' => 'Rpc', 'in' => 'query', - 'style' => 'repeatList', + 'schema' => ['description' => 'RPC interface name.', 'type' => 'string', 'required' => false, 'example' => '/eventCenter', 'title' => ''], + ], + [ + 'name' => 'Db', + 'in' => 'query', + 'schema' => ['description' => 'The database domain name.', 'type' => 'string', 'required' => false, 'example' => 'rm-xxx.mysql.rds.aliyuncs.com:3306', 'title' => ''], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the database.'."\n", 'type' => 'string', 'required' => false, 'example' => 'orders', 'title' => ''], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1595568910000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1671952708499', 'title' => ''], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The task IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the synthetic monitoring task.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '16720', - ], - 'required' => true, - 'maxItems' => 30, + 'description' => 'The filter conditions.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'The filter conditions.'."\n", 'example' => '"rootIp":"127.0.0.1"', 'title' => ''], + 'title' => '', + 'example' => '', ], ], ], @@ -35221,2091 +24752,1381 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', - ], - 'Result' => [ - 'description' => 'Indicates whether the specified tasks are deleted.'."\n" - ."\n" - .'* `true`: The tasks are deleted.'."\n" - .'* `false`: The tasks fail to be deleted.'."\n", - 'type' => 'string', - 'example' => 'true', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'], + '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', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message.'."\n", 'type' => 'string', 'example' => 'null', 'title' => ''], + 'Data' => ['description' => 'The returned struct.'."\n", 'type' => 'any', 'example' => '"Data": {'."\n" + .' "nodes": ['."\n" + .' {'."\n" + .' "data": {'."\n" + .' "duration": 0.2254335260115607,'."\n" + .' "requests": 1211,'."\n" + .' "type": "MYSQL",'."\n" + .' "errors": 0'."\n" + .' },'."\n" + .' "id": "ggxw4lnjuz@c0507xxxx##MYSQL",'."\n" + .' "label": "mysql-pod:3306(cart_db)"'."\n" + .' }'."\n" + .' ],'."\n" + .' "edges": ['."\n" + .' {'."\n" + .' "data": {'."\n" + .' "duration": 0.03333333333333333,'."\n" + .' "requests": 600,'."\n" + .' "type": "UNKNOWN",'."\n" + .' "errors": 0'."\n" + .' },'."\n" + .' "id": "1974097372",'."\n" + .' "source": "ggxw4lnjuz@456xxxxx",'."\n" + .' "target": "ggxw4lnjuz@c0507xxxx"'."\n" + .' }'."\n" + .' ]'."\n" + .' }', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', - 'title' => 'DeleteSyntheticTask', - ], - 'CreateIntegration' => [ - 'summary' => 'Creates an alert integration.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ParameterRegionIdMissing', 'errorMessage' => 'You must specify regionId.', 'description' => 'You must specify regionId.'], + ['errorCode' => 'ParameterTopologyTypeIllegal', 'errorMessage' => 'The specified topologyType is invalid.', 'description' => 'The specified topologyType is invalid.'], + ['errorCode' => 'ParameterTimeStampIllegal', 'errorMessage' => 'The specified timeStamp is invalid.', 'description' => 'The specified timeStamp is invalid.'], + ], + 403 => [ + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ], + [ + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The application does not exist.', 'description' => 'The application does not exist.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"null\\",\\n \\"Data\\": \\"\\\\\\"Data\\\\\\": {\\\\n \\\\\\"nodes\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"duration\\\\\\": 0.2254335260115607,\\\\n \\\\\\"requests\\\\\\": 1211,\\\\n \\\\\\"type\\\\\\": \\\\\\"MYSQL\\\\\\",\\\\n \\\\\\"errors\\\\\\": 0\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"ggxw4lnjuz@c0507xxxx##MYSQL\\\\\\",\\\\n \\\\\\"label\\\\\\": \\\\\\"mysql-pod:3306(cart_db)\\\\\\"\\\\n }\\\\n ],\\\\n \\\\\\"edges\\\\\\": [\\\\n {\\\\n \\\\\\"data\\\\\\": {\\\\n \\\\\\"duration\\\\\\": 0.03333333333333333,\\\\n \\\\\\"requests\\\\\\": 600,\\\\n \\\\\\"type\\\\\\": \\\\\\"UNKNOWN\\\\\\",\\\\n \\\\\\"errors\\\\\\": 0\\\\n },\\\\n \\\\\\"id\\\\\\": \\\\\\"1974097372\\\\\\",\\\\n \\\\\\"source\\\\\\": \\\\\\"ggxw4lnjuz@456xxxxx\\\\\\",\\\\n \\\\\\"target\\\\\\": \\\\\\"ggxw4lnjuz@c0507xxxx\\\\\\"\\\\n }\\\\n ]\\\\n }\\"\\n}","type":"json"}]', + 'title' => 'QueryAppTopology', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'QueryCommercialUsage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'IntegrationName', - 'in' => 'formData', + 'name' => 'IntervalInSec', + 'in' => 'query', 'schema' => [ - 'title' => '集成名称', - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CloudMonitor integration'."\n", + 'description' => 'The time interval between data slices. Unit: seconds. Minimum value: 3600.'."\n" + ."\n" + .'Valid values:'."\n" + ."\n" + .'* 3600: 1 hour'."\n" + .'* 86400: 1 day'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'enumValueTitles' => [3600 => '', 86400 => ''], + 'example' => '3600', + 'default' => '2147483647', + 'title' => '', ], ], [ - 'name' => 'IntegrationProductType', - 'in' => 'formData', + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775806', 'minimum' => '0', 'example' => '1699200000000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775806', 'minimum' => '0', 'example' => '1699286400000', 'title' => ''], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', 'schema' => [ - 'title' => '集成产品类型', - 'description' => 'The service of the alert integration. Valid values:'."\n" + 'description' => 'The dimension by which data is sorted.'."\n" ."\n" - .'* CLOUD_MONITOR: CloudMonitor'."\n" - .'* LOG_SERVICE: Log Service'."\n", + .'Valid value:'."\n" + ."\n" + .'* dataType'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n" + ."\n" + .' <!-- -->'."\n", 'type' => 'string', - 'required' => true, - 'example' => 'CLOUD_MONITOR', + 'required' => false, + 'enumValueTitles' => ['dataType' => 'dataType'], + 'example' => 'dataType', + 'title' => '', ], ], [ - 'name' => 'Description', - 'in' => 'formData', + 'name' => 'Metric', + 'in' => 'query', 'schema' => [ - 'title' => '集成描述', - 'description' => 'The description of the alert integration.'."\n", + 'description' => 'The name of the metric. Valid value: USAGEFEE.STAT.'."\n", 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => ['USAGEFEE.STAT' => 'USAGEFEE.STAT'], + 'example' => 'USAGEFEE.STAT'."\n", + 'title' => '', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which data is sorted. Valid value:'."\n" + ."\n" + .'* `ASC`: ascending order'."\n" + .'* `DESC`: descending order'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], + ], + [ + 'name' => 'AdvancedFilters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'The filter conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the filter condition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'regionId', 'title' => ''], + 'Value' => ['description' => 'The value of the filter condition.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'OpType' => [ + 'description' => 'The operator. Valid values: eq and in.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['in' => 'in', 'eq' => 'eq'], + 'example' => 'eq', + 'title' => '', + ], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'Test'."\n", + 'maxItems' => 15, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'AutoRecover', - 'in' => 'formData', + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '是否开启恢复，默认true', - 'description' => 'Specifies whether to automatically clear alert events. Default value: true. Valid values:'."\n" + 'description' => 'The dimensions of the metric that you want to query. Valid values:'."\n" ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', + .'* dataType: data type'."\n" + .'* productType: product type'."\n" + .'* instanceId: instance ID'."\n" + .'* instanceName: instance name'."\n" + .'* instanceType: instance type'."\n", + 'type' => 'array', + 'items' => ['description' => 'The dimension of the metric.'."\n", 'type' => 'string', 'required' => false, 'example' => 'dataType', 'title' => ''], 'required' => false, - 'example' => 'true', + 'maxItems' => 15, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RecoverTime', - 'in' => 'formData', + 'name' => 'Measures', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '恢复时间，默认300s', - 'description' => 'The period of time within which alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The measures of the metric that you want to query.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The measure of the metric. Valid value: byte_sum.'."\n", + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => ['byte_sum' => 'byte_sum'], + 'example' => 'byte_sum', + 'title' => '', + ], 'required' => false, - 'example' => '300', + 'maxItems' => 15, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RegionId', + 'name' => 'QueryType', 'in' => 'query', 'schema' => [ - 'description' => 'The region ID.'."\n", + 'title' => '', + 'description' => 'The data type. Valid values:'."\n" + ."\n" + .'* instantQuery: non-time series'."\n" + .'* timeSeriesQuery: time series'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'required' => true, + 'enumValueTitles' => ['timeSeriesQuery' => 'timeSeriesQuery', 'instantQuery' => 'instantQuery'], + 'example' => 'instantQuery', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'Integration' => [ - 'description' => 'The returned information about the alert integration.'."\n", + 'Code' => ['description' => 'The response status. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'IntegrationId' => [ - 'title' => '集成ID', - 'description' => 'The ID of the alert integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'IntegrationName' => [ - 'title' => '集成名称', - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor integration'."\n", - ], - 'IntegrationProductType' => [ - 'title' => '集成产品类型', - 'description' => 'The service of the alert integration. Valid values:'."\n" - ."\n" - .'* CLOUD_MONITOR: CloudMonitor'."\n" - .'* LOG_SERVICE: Log Service'."\n", - 'type' => 'string', - 'example' => 'CLOUD_MONITOR', - ], - 'Description' => [ - 'title' => '集成描述', - 'description' => 'The description of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'AutoRecover' => [ - 'title' => '是否开启恢复，默认true', - 'description' => 'Indicates whether alert events are automatically cleared. Default value: true. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RecoverTime' => [ - 'title' => '恢复时间，默认300s', - 'description' => 'The period of time within which alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', + 'Complete' => ['description' => 'Indicates whether a multi-region query is complete. Valid values:'."\n" + ."\n" + .'* **true**'."\n" + .'* **false**'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Items' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The queried data.'."\n", 'type' => 'object', 'example' => '{'."\n" + .' "date": "1697108400",'."\n" + .' "dataType": "metrics",'."\n" + .' "byte_sum": 9497922'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Integration\\": {\\n \\"IntegrationId\\": 1234,\\n \\"IntegrationName\\": \\"云监控集成\\",\\n \\"IntegrationProductType\\": \\"CLOUD_MONITOR\\",\\n \\"Description\\": \\"测试\\",\\n \\"AutoRecover\\": true,\\n \\"RecoverTime\\": 300\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateIntegrationResponse>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n <Integration>\\n <IntegrationId>1234</IntegrationId>\\n <IntegrationName>云监控集成</IntegrationName>\\n <IntegrationProductType>CLOUD_MONITOR</IntegrationProductType>\\n <Description>测试</Description>\\n <AutoRecover>true</AutoRecover>\\n <RecoverTime>300</RecoverTime>\\n </Integration>\\n</CreateIntegrationResponse>","errorExample":""}]', - 'title' => 'CreateIntegration', - ], - 'UpdateIntegration' => [ - 'summary' => 'Modifies the information about an integration.', - 'methods' => [ - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMetricIllegal', 'errorMessage' => 'The specified metric is invalid.', 'description' => 'The specified metric is invalid.'], + ['errorCode' => 'ParameterMeasuresIllegal', 'errorMessage' => 'The specified Measures is invalid.', 'description' => 'The specified Measures is invalid.'], + ['errorCode' => 'ParameterTimeStampIllegal', 'errorMessage' => 'The specified timeStamp is invalid.', 'description' => 'The specified timeStamp is invalid.'], + ['errorCode' => 'ParameterOrderIllegal', 'errorMessage' => 'The specified order is invalid.', 'description' => 'The specified order is invalid.'], + ['errorCode' => 'ParameterPageSizeIllegal', 'errorMessage' => 'The specified PageSize is invalid.', 'description' => 'The specified PageSize is invalid.'], + ['errorCode' => 'ParameterIntervalIllegal', 'errorMessage' => 'The specified interval is invalid.', 'description' => 'The specified interval is invalid.'], + ['errorCode' => 'ParameterMeasuresMissing', 'errorMessage' => 'You must specify measures.', 'description' => 'You must specify measures.'], + ['errorCode' => 'ParameterDimensionsIllegal', 'errorMessage' => 'The specified dimensions is invalid.', 'description' => 'The specified dimensions is invalid.'], + ['errorCode' => 'ParameterRegionIdIllegal', 'errorMessage' => 'The specified RegionId is invalid.', 'description' => 'The specified RegionId is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"99A663CB-8D7B-4B0D-A006-03C8EE38E7BB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Complete\\": true,\\n \\"Items\\": [\\n {\\n \\"date\\": \\"1697108400\\",\\n \\"dataType\\": \\"metrics\\",\\n \\"byte_sum\\": 9497922\\n }\\n ]\\n }\\n}","type":"json"}]', + 'title' => 'QueryCommercialUsage', + 'summary' => 'Queries the amount of data written to Application Monitoring, Managed Service for OpenTelemetry, Managed Service for Prometheus, and Real User Monitoring (RUM).', + 'extraInfo' => '* 调用时为什么会出现RAM的权限问题？ 这可能是由于该RAM角色没有权限，您可以为用户添加权限，请参见借助RAM角色实现跨云账号访问资源。'."\n" + .'* 怎么拉取列表数据（不考虑时间粒度）？ 将queryType设置为instantQuery'."\n" + .'* 返回时间非法，目前intervalInSec仅支持3600以及8600,不支持其他间隔', + 'changeSet' => [ + ['createdAt' => '2024-07-25T02:05:45.000Z', 'description' => 'Response parameters changed'], ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'QueryMetricByPage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'write', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'IntegrationId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the alert integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'IntegrationName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CloudMonitor integration'."\n", - ], - ], - [ - 'name' => 'IntegrationProductType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The service of the alert integration. Valid values:'."\n" - ."\n" - .'* CLOUD_MONITOR: CloudMonitor'."\n" - .'* LOG_SERVICE: Log Service'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CLOUD_MONITOR', - ], + 'name' => 'IntervalInSec', + 'in' => 'query', + 'schema' => ['description' => 'The time interval at which you want to query metric data. Unit: milliseconds. Minimum value: 60000.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'maximum' => '2147483647', 'minimum' => '0', 'example' => '100000', 'default' => '2147483647', 'title' => ''], ], [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the alert integration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test'."\n", - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The start of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775806', 'minimum' => '0', 'example' => '1667287695000', 'title' => ''], ], [ - 'name' => 'AutoRecover', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to automatically clear alert events. Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775806', 'minimum' => '0', 'example' => '1667546895000', 'title' => ''], ], [ - 'name' => 'RecoverTime', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The period of time within which alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '300', - ], + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => ['description' => 'The dimension for arranging metrics in sequence. For more information, see the supplementary metrics.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pid', 'title' => ''], ], [ - 'name' => 'DuplicateKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The fields whose values are deduplicated.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'LABEL.dimensions::LABEL.ruleId', - ], + 'name' => 'Metric', + 'in' => 'query', + 'schema' => ['description' => 'The metric that you want to query. You cannot specify a custom metric. For more information, see the "Application monitoring metrics that can be queried" section.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'appstat.host', 'title' => ''], ], [ - 'name' => 'State', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Indicates whether the alert integration was enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'Order', + 'in' => 'query', + 'schema' => ['description' => 'The order in which measures are sorted. Valid values:'."\n" + ."\n" + .'* `ASC`: ascending order'."\n" + .'* `DESC`: descending order'."\n" + ."\n" + .'> If you do not specify the parameter, data is not sorted.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ASC', 'title' => ''], ], [ - 'name' => 'Stat', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[0,0]', - ], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The page number. Default value: `1`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '1', 'default' => '1', 'title' => ''], ], [ - 'name' => 'Liveness', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The activity of the alert integration'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ready', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is no longer supported. The number of entries per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'maximum' => '2147483647', 'minimum' => '1', 'example' => '10', 'default' => '10', 'title' => ''], ], [ - 'name' => 'FieldRedefineRules', - 'in' => 'formData', + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created. For more information, see the description of the FieldRedefineRules parameter.'."\n", - 'type' => 'string', + 'description' => 'The filter conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The information about the array object.'."\n", + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the filter condition. You must set the key to `pid` or `regionId`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pid', 'title' => ''], + 'Value' => ['description' => 'The value of the filter condition. You must set the value of the `pid` or `regionId` condition. For information about how to obtain the `pid`, see the "Obtain the PID of an application" section.'."\n", 'type' => 'string', 'required' => false, 'example' => 'xxx@74xxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '\\[ { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"alertname", "expression":null, "mappingRuleList":\\[ ], "name":"Alert name", "integrationId":1234, "jsonPath":"$.alertName", "id":10001, "fieldType":"LABEL" }, { "redefineType":"MAP", "matchExpression":null, "fieldName":"severity", "expression":null, "mappingRuleList":\\[ { "mappingValue":"critical", "mappingName":"P1", "mappingType":"MAP", "originValue":"CRITICAL" }, { "mappingValue":"error", "mappingName":"P2", "mappingType":"MAP", "originValue":"WARN" }, { "mappingValue":"warning", "mappingName":"P3", "mappingType":"MAP", "originValue":"INFO" } ], "name":"Alert level", "integrationId":1234, "jsonPath":"$.triggerLevel", "id":10002, "fieldType":"LABEL" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"message", "expression":"{{$labels.namespace}} / {{$labels.dimensions}} Alert content {{ $labels.alertname }}, Current value {{$value}}.", "mappingRuleList":\\[ ], "name":"Alert description", "integrationId":1234, "jsonPath":null, "id":10003, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"value", "expression":null, "mappingRuleList":\\[ ], "name":"Alert sample value", "integrationId":1234, "jsonPath":"$.curValue", "id":10004, "fieldType":"ANNOTATION" }, { "redefineType":"EXTRACT", "matchExpression":null, "fieldName":"source", "expression":null, "mappingRuleList":\\[ ], "name":"Source", "integrationId":1234, "jsonPath":null, "id":10007, "fieldType":"LABEL" }, { "redefineType":"ADD", "matchExpression":null, "fieldName":"generatorUrl", "expression":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}\\&searchValue=\\&searchType=name\\&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "mappingRuleList":\\[ ], "name":"Event URL", "integrationId":1234, "jsonPath":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}\\&searchValue=\\&searchType=name\\&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}", "id":10012, "fieldType":"GENERATE_URL" } ]'."\n", + 'maxItems' => 15, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ExtendedFieldRedefineRules', - 'in' => 'formData', + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The extended mapped fields are mapped to the fields of ARMS alerts. For more information, see the description of the ExtendedFieldRedefineRules parameter.'."\n", - 'type' => 'string', + 'description' => 'The dimensions of the metric that you want to query.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The dimensions of the metric that you want to query. For more information, see the "Application monitoring metrics that can be queried" section. You can specify a maximum of five dimensions.'."\n", 'type' => 'string', 'required' => false, 'example' => 'pid', 'title' => ''], 'required' => false, - 'example' => '['."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"dimensions",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - ."\n" - .' ],'."\n" - .' "name":"dimensions",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.dimensions",'."\n" - .' "id":10013,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"expression",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - ."\n" - .' ],'."\n" - .' "name":"expression",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.expression",'."\n" - .' "id":10014,'."\n" - .' "fieldType":"LABEL"'."\n" - .' }'."\n" - .']', + 'example' => '["detector_browser","detector_device"]', + 'maxItems' => 15, + 'title' => '', ], ], [ - 'name' => 'InitiativeRecoverField', - 'in' => 'formData', + 'name' => 'Measures', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" - ."\n" - .'> Only the Log Service alert integration supports the parameter.'."\n", - 'type' => 'string', + 'description' => 'The measures of the metric that you want to query.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The measures of the metric that you want to query. For more information, see the "Application monitoring metrics that can be queried" section. You can specify a maximum of five measures.'."\n", 'type' => 'string', 'required' => false, 'example' => 'instanceCount', 'title' => ''], 'required' => false, - 'example' => '$.status', + 'example' => 'pv', + 'maxItems' => 15, + 'title' => '', ], ], [ - 'name' => 'InitiativeRecoverValue', - 'in' => 'formData', + 'name' => 'CustomFilters', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" - ."\n" - .'> Only the Log Service alert integration supports the parameter.'."\n", - 'type' => 'string', + 'description' => 'Custom filter conditions.'."\n", + 'type' => 'array', + 'items' => ['description' => 'Custom filter conditions. Separate multiple filter conditions with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '["not rpcType:40","not rpcType:41"]', 'title' => ''], 'required' => false, - 'example' => 'ok', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'Integration' => [ - 'description' => 'The Information about the alert integration.'."\n", + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* 2XX: The request was successful.'."\n" + .'* 3XX: A redirection message was returned.'."\n" + .'* 4XX: The request was invalid.'."\n" + .'* 5XX: A server error occurred.'."\n", 'type' => 'string', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the call fails.'."\n", 'type' => 'string', 'example' => 'StartTime is mandatory for this action.', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '687F9CB7-4798-57BF-A6EE-E6CC76******', 'title' => ''], + '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', 'title' => ''], + 'Data' => [ + 'description' => 'The information about the array object.'."\n", 'type' => 'object', 'properties' => [ - 'IntegrationId' => [ - 'description' => 'The ID of the alert integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'IntegrationName' => [ - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor integration'."\n", - ], - 'IntegrationProductType' => [ - 'description' => 'The service of the alert integration. Valid values:'."\n" - ."\n" - .'* CLOUD_MONITOR: CloudMonitor'."\n" - .'* LOG_SERVICE: Log Service'."\n", - 'type' => 'string', - 'example' => 'CLOUD_MONITOR', - ], - 'Description' => [ - 'description' => 'The description of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'ApiEndpoint' => [ - 'description' => 'The endpoint of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******', - ], - 'ShortToken' => [ - 'description' => 'The authentication token of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'ymQBN******', - ], - 'AutoRecover' => [ - 'description' => 'Indicates whether alert events are automatically cleared. Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RecoverTime' => [ - 'description' => 'The time when alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'DuplicateKey' => [ - 'description' => 'The fields whose values are deduplicated.'."\n", - 'type' => 'string', - 'example' => 'LABEL.dimensions::LABEL.ruleId', - ], - 'State' => [ - 'description' => 'Indicates whether the alert integration is enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Stat' => [ - 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '[0,0]', - ], - ], - 'Liveness' => [ - 'description' => 'The activity of the alert integration'."\n", - 'type' => 'string', - 'example' => 'ready', - ], - 'FieldRedefineRules' => [ - 'description' => 'The predefined mapped fields of the alert source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created.'."\n", - 'type' => 'object', - 'example' => '', - ], - ], - 'ExtendedFieldRedefineRules' => [ - 'description' => 'The extended mapped fields of the alert source.'."\n", + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Total' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Page' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Completed' => ['description' => 'Whether the paging query ends.'."\n" + ."\n" + .'true: end.'."\n" + .'false: Need to continue pagination (continue to query after CurrentPage+1).', 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Items' => [ + 'description' => 'The data entries returned.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The extended mapped fields are mapped to the fields of ARMS alerts.'."\n", - 'type' => 'object', - 'example' => '['."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"dimensions",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - ."\n" - .' ],'."\n" - .' "name":"dimensions",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.dimensions",'."\n" - .' "id":10013,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"expression",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - ."\n" - .' ],'."\n" - .' "name":"expression",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.expression",'."\n" - .' "id":10014,'."\n" - .' "fieldType":"LABEL"'."\n" - .' }'."\n" - .']', - ], - ], - 'InitiativeRecoverField' => [ - 'description' => 'The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" - ."\n" - .'> Only Log Service supports this parameter.'."\n", - 'type' => 'string', - 'example' => '$.status', - ], - 'InitiativeRecoverValue' => [ - 'description' => 'The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" - ."\n" - .'> Only Log Service supports this parameter.'."\n", - 'type' => 'string', - 'example' => 'ok', + 'items' => ['description' => 'The data entries returned.'."\n", 'type' => 'object', 'example' => '[]', 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Integration\\": {\\n \\"IntegrationId\\": 1234,\\n \\"IntegrationName\\": \\"云监控集成\\",\\n \\"IntegrationProductType\\": \\"CLOUD_MONITOR\\",\\n \\"Description\\": \\"测试\\",\\n \\"ApiEndpoint\\": \\"https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******\\",\\n \\"ShortToken\\": \\"ymQBN******\\",\\n \\"AutoRecover\\": true,\\n \\"RecoverTime\\": 300,\\n \\"DuplicateKey\\": \\"LABEL.dimensions::LABEL.ruleId\\",\\n \\"State\\": true,\\n \\"Stat\\": [\\n 0\\n ],\\n \\"Liveness\\": \\"ready\\",\\n \\"FieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"alertname\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警名称\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.alertName\\",\\n \\"id\\": 10001,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"MAP\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"severity\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [\\n {\\n \\"mappingValue\\": \\"critical\\",\\n \\"mappingName\\": \\"P1\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"CRITICAL\\"\\n },\\n {\\n \\"mappingValue\\": \\"error\\",\\n \\"mappingName\\": \\"P2\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"WARN\\"\\n },\\n {\\n \\"mappingValue\\": \\"warning\\",\\n \\"mappingName\\": \\"P3\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"INFO\\"\\n }\\n ],\\n \\"name\\": \\"告警等级\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.triggerLevel\\",\\n \\"id\\": 10002,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"message\\",\\n \\"expression\\": \\"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警描述\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10003,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"value\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警样本值\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.curValue\\",\\n \\"id\\": 10004,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"source\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"来源\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10007,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"ADD\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"generatorUrl\\",\\n \\"expression\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"事件地址\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"id\\": 10012,\\n \\"fieldType\\": \\"GENERATE_URL\\"\\n }\\n ]\\n ],\\n \\"ExtendedFieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"dimensions\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"dimensions\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.dimensions\\",\\n \\"id\\": 10013,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"expression\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"expression\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.expression\\",\\n \\"id\\": 10014,\\n \\"fieldType\\": \\"LABEL\\"\\n }\\n ]\\n ],\\n \\"InitiativeRecoverField\\": \\"$.status\\",\\n \\"InitiativeRecoverValue\\": \\"ok\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UpdateIntegrationResponse>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n <Integration>\\n <IntegrationId>1234</IntegrationId>\\n <IntegrationName>云监控集成</IntegrationName>\\n <IntegrationProductType>CLOUD_MONITOR</IntegrationProductType>\\n <Description>测试</Description>\\n <ApiEndpoint>https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******</ApiEndpoint>\\n <ShortToken>ymQBN******</ShortToken>\\n <AutoRecover>true</AutoRecover>\\n <RecoverTime>300</RecoverTime>\\n <DuplicateKey>LABEL.dimensions::LABEL.ruleId</DuplicateKey>\\n <State>true</State>\\n <Liveness>ready</Liveness>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>alertname</fieldName>\\n <expression/>\\n <name>告警名称</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.alertName</jsonPath>\\n <id>10001</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>MAP</redefineType>\\n <matchExpression/>\\n <fieldName>severity</fieldName>\\n <expression/>\\n <mappingRuleList>\\n <mappingValue>critical</mappingValue>\\n <mappingName>P1</mappingName>\\n <mappingType>MAP</mappingType>\\n <originValue>CRITICAL</originValue>\\n </mappingRuleList>\\n <mappingRuleList>\\n <mappingValue>error</mappingValue>\\n <mappingName>P2</mappingName>\\n <mappingType>MAP</mappingType>\\n <originValue>WARN</originValue>\\n </mappingRuleList>\\n <mappingRuleList>\\n <mappingValue>warning</mappingValue>\\n <mappingName>P3</mappingName>\\n <mappingType>MAP</mappingType>\\n <originValue>INFO</originValue>\\n </mappingRuleList>\\n <name>告警等级</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.triggerLevel</jsonPath>\\n <id>10002</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>message</fieldName>\\n <expression>{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。</expression>\\n <name>告警描述</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10003</id>\\n <fieldType>ANNOTATION</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>value</fieldName>\\n <expression/>\\n <name>告警样本值</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.curValue</jsonPath>\\n <id>10004</id>\\n <fieldType>ANNOTATION</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>imageUrl</fieldName>\\n <expression/>\\n <name>告警图片</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10005</id>\\n <fieldType>ANNOTATION</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>check</fieldName>\\n <expression/>\\n <name>检查项</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10006</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>source</fieldName>\\n <expression/>\\n <name>来源</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10007</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>class</fieldName>\\n <expression/>\\n <name>分类</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10008</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>service</fieldName>\\n <expression/>\\n <name>服务</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10009</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>startat</fieldName>\\n <expression/>\\n <name>开始时间</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10010</id>\\n <fieldType>START_AT</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>endat</fieldName>\\n <expression/>\\n <name>结束时间</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10011</id>\\n <fieldType>END_AT</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>ADD</redefineType>\\n <matchExpression/>\\n <fieldName>generatorUrl</fieldName>\\n <expression>https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}</expression>\\n <name>事件地址</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}</jsonPath>\\n <id>10012</id>\\n <fieldType>GENERATE_URL</fieldType>\\n </FieldRedefineRules>\\n <ExtendedFieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>dimensions</fieldName>\\n <expression/>\\n <name>dimensions</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.dimensions</jsonPath>\\n <id>10013</id>\\n <fieldType>LABEL</fieldType>\\n </ExtendedFieldRedefineRules>\\n <ExtendedFieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>expression</fieldName>\\n <expression/>\\n <name>expression</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.expression</jsonPath>\\n <id>10014</id>\\n <fieldType>LABEL</fieldType>\\n </ExtendedFieldRedefineRules>\\n </Integration>\\n</UpdateIntegrationResponse>","errorExample":""}]', - 'title' => 'UpdateIntegration', - 'requestParamsDescription' => '### FieldRedefineRules and ExtendedFieldRedefineRules description'."\n" + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMetricIllegal', 'errorMessage' => 'The specified metric is invalid.', 'description' => 'The specified metric is invalid.'], + ['errorCode' => 'ParameterMeasuresIllegal', 'errorMessage' => 'The specified Measures is invalid.', 'description' => 'The specified Measures is invalid.'], + ['errorCode' => 'ParameterTimeStampIllegal', 'errorMessage' => 'The specified timeStamp is invalid.', 'description' => 'The specified timeStamp is invalid.'], + ['errorCode' => 'ParameterOrderIllegal', 'errorMessage' => 'The specified order is invalid.', 'description' => 'The specified order is invalid.'], + ['errorCode' => 'ParameterZeroStrategyIllegal', 'errorMessage' => 'The specified zeroStrategy is invalid.', 'description' => 'The specified zeroStrategy is invalid.'], + ['errorCode' => 'ParameterPageSizeIllegal', 'errorMessage' => 'The specified PageSize is invalid.', 'description' => 'The specified PageSize is invalid.'], + ['errorCode' => 'ParameterIntervalIllegal', 'errorMessage' => 'The specified interval is invalid.', 'description' => 'The specified interval is invalid.'], + ['errorCode' => 'ParameterMeasuresMissing', 'errorMessage' => 'You must specify measures.', 'description' => 'You must specify measures.'], + ['errorCode' => 'ParameterDimensionsIllegal', 'errorMessage' => 'The specified dimensions is invalid.', 'description' => 'The specified dimensions is invalid.'], + ['errorCode' => 'ParameterPidMissing', 'errorMessage' => 'You must specify pid.', 'description' => 'You must specify pid.'], + ['errorCode' => 'ParameterRegionIdIllegal', 'errorMessage' => 'The specified RegionId is invalid.', 'description' => 'The specified RegionId is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => 'The specified region is invalid.', 'description' => 'The specified region is invalid.'], + ], + 403 => [ + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ], + [ + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The application does not exist.', 'description' => 'The application does not exist.'], + ['errorCode' => 'RunningTaskNotExist', 'errorMessage' => 'Application data collection task does not exist or has been stopped.', 'description' => 'Application data collection task does not exist or has been stopped'], + ], + 429 => [ + ['errorCode' => 'OperationIsThrottled', 'errorMessage' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.', 'description' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.'], + ], + 452 => [ + ['errorCode' => 'OperationTimeOut', 'errorMessage' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.', 'description' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.'], + ], + ], + 'title' => 'QueryMetricByPage', + 'summary' => 'Queries an Application Monitoring metric or a Browser Monitoring metric.', + 'requestParamsDescription' => '## Obtain the PID of an application'."\n" ."\n" - .'Example:'."\n" + .'In the left-side navigation pane of the ARMS console, choose **Application Monitoring > Application List** or **Browser Monitoring > Browser Monitoring**. On the Application List or Browser Monitoring page, click the name of the application that you want to view.'."\n" ."\n" - .'```'."\n" - .'['."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"alertname",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'The URL in the address bar contains the **process ID (PID)** of the application. The PID is indicated in the `pid=xxx` format. The PID is usually percent encoded as `xxx%40xxx`. You must modify this value to remove the percent encoding. For example, if the PID in the URL is `eb4zdose6v%409781be0f44d****`, you must replace `%40` with an at sign (`@`) to obtain `eb4zdose6v@9781be0f44d****`.'."\n" ."\n" - .' ],'."\n" - .' "name":"Alert name",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.alertName",'."\n" - .' "id":10001,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"MAP",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"severity",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - .' {'."\n" - .' "mappingValue":"critical",'."\n" - .' "mappingName":"P1",'."\n" - .' "mappingType":"MAP",'."\n" - .' "originValue":"CRITICAL"'."\n" - .' },'."\n" - .' {'."\n" - .' "mappingValue":"error",'."\n" - .' "mappingName":"P2",'."\n" - .' "mappingType":"MAP",'."\n" - .' "originValue":"WARN"'."\n" - .' },'."\n" - .' {'."\n" - .' "mappingValue":"warning",'."\n" - .' "mappingName":"P3",'."\n" - .' "mappingType":"MAP",'."\n" - .' "originValue":"INFO"'."\n" - .' }'."\n" - .' ],'."\n" - .' "name":"Alert level",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.triggerLevel",'."\n" - .' "id":10002,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"message",'."\n" - .' "expression":"{{$labels.namespace}} / {{$labels.dimensions}} Alert content {{ $labels.alertname }}, Current value {{$value}}.",'."\n" - .' "mappingRuleList":['."\n" + .'## Application Monitoring metrics supporting query'."\n" ."\n" - .' ],'."\n" - .' "name":"Alert description",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10003,'."\n" - .' "fieldType":"ANNOTATION"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"value",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'**Note** You must set the **pid** and `regionId` filter conditions by specifying the `Filters` parameter. You must set all known filter conditions by specifying the **Filters** parameter to define the range of query results. If no filter conditions are known, you can specify one or more **dimensions** provided in the following table to narrow down the query range.'."\n" ."\n" - .' ],'."\n" - .' "name":"Alert sample value",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.curValue",'."\n" - .' "id":10004,'."\n" - .' "fieldType":"ANNOTATION"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"imageUrl",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'|Metric|Description|Dimension|Measurement|'."\n" + .'|---|---|---|---|'."\n" + .'|appstat.vm|A collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.|\\- pid\\- rootIp|GC metrics:\\- youngGcCount: the number of GCs in the young generation\\- oldGcCount: the number of full heap GCs (full GCs)\\- youngGcTime: the amount of time consumed by GCs in the young generation\\- oldGcTime: the amount of time consumed by full GCs\\- youngGcCountInstant: the instantaneous value of the number of GCs in the young generation\\- oldGcCountInstant: the instantaneous value of the number of full GCs\\- youngGcTimeInstant: the instantaneous value of the amount of time consumed by GCs in the young generation\\- oldGcTimeInstant: the instantaneous value of the amount of time consumed by full GCs|'."\n" + .'|appstat.vm|A collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to garbage collections (GCs), heap memory, non-heap memory, and threads.|\\- pid\\- rootIp|Heap memory and non-heap memory:\\- edenSpace: the eden space in the young generation\\- oldGen: the old generation\\- survivorSpace: the survivor space in the young generation\\- metaSpace: the metaspace\\- nonHeapCommitted: the non-heap memory\\- nonHeapInit: the initial value of the non-heap memory\\- nonHeapMax: the maximum value of the non-heap memory\\- nonHeapUsed: the usage of the non-heap memory\\- directUsed: the amount of used direct buffer in the off-heap memory\\- directCapacity: the total amount of direct buffer in the off-heap memory|'."\n" + .'|appstat.vm|A collection of common metrics that are shown in the JVM monitoring chart on the application details page. These metrics are related to GCs, heap memory, non-heap memory, and threads.|\\- pid\\- rootIp|Number of threads:\\- threadCount: the total number of threads\\- threadNewCount: the number of new threads\\- threadDeadlockCount: the number of deadlocked threads in the JVM\\- threadRunnableCount: the number of runnable threads in the JVM\\- threadTerminatedCount: the number of terminated threads\\- threadTimedWaitCount: the number of threads in the timed\\_waiting state\\- threadWaitCount: the number of threads in the waiting state\\- threadBlockedCount: the number of blocked threads|'."\n" + .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|instanceCount: the number of instances|'."\n" + .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|CPU:\\- systemCpuIdle: the percentage of idle CPU in the last 5 seconds, which is not displayed in the ARMS console\\- systemCpuSystem: the CPU utilization of the system in the last 5 seconds\\- systemCpuUser: the percentage of CPU occupied by users in the last 5 seconds\\- systemCpuIoWait: the percentage of CPU consumed for I/O waiting in the last 5 seconds|'."\n" + .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|Physical memory:\\- systemMemFree: the amount of free memory (Unit: KB)\\- systemMemUsed: the amount of used memory (Unit: KB)\\- systemMemTotal: the total amount of memory, which is not displayed in the ARMS console (Unit: KB)\\- systemMemBuffers: the amount of memory in the buffer cache\\- systemMemCached: the amount of memory in the page cache|'."\n" + .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|Disk:\\- systemDiskFree: the size of free disk space in bytes\\- systemDiskUsedRatio: the usage of the disk space\\- SystemDiskTotal: the total size of disk space in bytes, which is not displayed in the ARMS console|'."\n" + .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|systemLoad: the load|'."\n" + .'|appstat.host|A collection of metrics for host monitoring. These metrics are related to instances, CPU, physical memory, disk, load, network traffic, and network packets.|\\- pid\\- rootIp|Network:\\- systemNetInPackets: the average number of packets received over the network per second in the last 30 seconds\\- systemNetOutPackets: the average number of packets sent over the network per second in the last 30 seconds\\- systemNetInErrs: the average number of frame errors received over the network per second in the last 30 seconds\\- systemNetOutErrs: the average number of errors sent over the network per second in the last 30 seconds\\- systemNetInBytes: the average number of bytes received over the network per second in the last 30 seconds\\- systemNetOutBytes: the average number of bytes sent over the network per second in the last 30 seconds|'."\n" + .'|appstat.database|A collection of metrics for database calls.|\\- pid\\- rpcType: the type of the call\\- endpoint: the database endpoint, which is localhost: 3306\\- destId: the database name, which is arms|\\- rt: the response time (Unit: milliseconds).\\- count: the number of requests.\\- error: the number of errors.\\- resultsize: This metric is available only for MySQL 5.x.\\- slowcount: the number of slow calls.|'."\n" + .'|appstat.incall|A collection of metrics related to application details.|\\- pid\\- rpcType\\- rootIp\\- rpc\\- ppid|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: the number of errors\\- errorrate: the error rate\\- qps: the number of queries per second|'."\n" + .'|appstat.exception|A collection of metrics related to exceptions.|\\- pid\\- rpc\\- endpoint\\- excepType\\- excepInfo|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: the number of errors|'."\n" + .'|appstat.sql|A collection of metrics related to slow SQL queries.|\\- pid\\- rpc\\- endpoint\\- sqlId|\\- rt: the response time (Unit: milliseconds).\\- count: the number of requests.\\- error: the number of errors.\\- slowcount: the number of slow calls.\\- resultsize: This metric is available only for MySQL 5.x.Note: If the value of the slow metric is true, the filter conditions do not take effect.|'."\n" + .'|appstat.mq.send|A collection of metrics related to message sending by using a message queue.|None|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: error: the number of errors\\- delay: the scheduling delay (Unit: milliseconds)|'."\n" + .'|appstat.mq.receive|A collection of metrics related to message receiving by using a message queue.|None|\\- rt: the response time (Unit: milliseconds)\\- count: the number of requests\\- error: error: the number of errors\\- delay: the scheduling delay (Unit: milliseconds)|'."\n" + .'|appstat.schedulerx|A collection of metrics related to SchedulerX calls.|\\- pid\\- rpcType\\- rootIp\\- rpc|count: the number of requests|'."\n" + .'|appstat.elasticsearch|A collection of metrics related to Elasticsearch calls.|\\- rpc\\- endpoint\\- opType: the type of the operation, such as index and search operations. This dimension is supported only when elasticsearch-rest-high-level-client is used.|count: the number of requests|'."\n" + .'|appstat.redis|A collection of metrics related to ApsaraDB for Redis calls.|\\- pid\\- rpcType\\- endpoint\\- opType\\- rpc|count: the number of requests|'."\n" + .'|appstat.status|The number of requests with specified status codes. Only HTTP requests are supported.|\\- pid\\- rootIp\\- rpc|\\- 200: the number of requests with the 200 status code (abnormal)\\- 2xx: the number of requests with 2XX status codes (abnormal)\\- 3xx: the number of requests with 3XX status codes\\- 4xx: the number of requests with 4XX status codes (client errors)\\- 5xx: the number of requests with 5XX status codes (server errors)|'."\n" ."\n" - .' ],'."\n" - .' "name":"Alert image",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10005,'."\n" - .' "fieldType":"ANNOTATION"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"check",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'## Browser Monitoring metrics supporting query'."\n" ."\n" - .' ],'."\n" - .' "name":"Check item",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10006,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"source",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'You can call the QueryMetric operation to query the following metrics of Browser Monitoring.'."\n" ."\n" - .' ],'."\n" - .' "name":"Source",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10007,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"class",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'**Note** You must set the **pid** and `regionId` filter conditions by specifying the `Filters` parameter. You must set all known filter conditions by specifying the **Filters** parameter to define the range of query results. If no filter conditions are known, you can specify one or more **dimensions** provided in the following table to narrow down the query range.'."\n" ."\n" - .' ],'."\n" - .' "name":"Category",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10008,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"service",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'|Metric|Description|Dimension|Measurement|'."\n" + .'|---|---|---|---|'."\n" + .'|webstat.api|Success rate of API requests|\\- api: the URL of the API without request parameters\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution|\\- count: the number of requests\\- rate: the success rate of API requests\\- avg\\_time: the average response time|'."\n" + .'|webstat.api.detail|API details|\\- api: the URL of the API without request parameters\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_browser\\_version: the version of the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- detector\\_os\\_version: the version of the operating system\\- domain: the domain name\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- msg: the returned message\\- page: the URL of the page\\- sr: the screen resolution|\\- count: the number of requests\\- fail\\_count: the number of failed API requests\\- fail\\_time: the response time for failed API requests\\- fail\\_uv: the number of users affected by failures\\- success\\_count: the number of successful API requests\\- success\\_rate: the success rate\\- success\\_time: the response time for successful API requests|'."\n" + .'|webstat.apicost|Response time for successful API requests|\\- api: the URL of the API without request parameters\\- code: the returned status code\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution|\\- count: the number of successful API requests\\- avg\\_time: the average response time for successful API requests|'."\n" + .'|webstat.apifailtime|Response time for failed API requests|\\- api: the URL of the API without request parameters\\- code: the returned status code\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution|\\- count: the number of failed API requests\\- avg\\_time: the average response time for failed API requests|'."\n" + .'|webstat.apimsg|Classification and aggregation of API response messages|\\- code: the returned status code\\- detector\\_app\\_version: the client version\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- msg: the error message\\- release: the version number\\- sr: the screen resolution\\- success: The value 1 indicates that the request is successful and the value 0 indicates that the request has failed.|count: the number of requests|'."\n" + .'|webstat.avg|Custom statistics: average|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- key: the custom key\\- sr: the screen resolution|\\- count: the total number of occurrences\\- pv: the number of page views\\- uv: the number of unique visitors\\- avg\\_val: the average value|'."\n" + .'|webstat.errcate|Error message ranking|\\- msg: the error message\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- sr: the screen resolution\\- release: the version number\\- environment: the environment\\- detector\\_app\\_version: the client version\\- detector\\_app: the client app|count: the number of errors|'."\n" + .'|webstat.index|Page view overview|\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- pv: the number of page views\\- uv: the number of unique visitors|'."\n" + .'|webstat.msg.top|Frequent errors|\\- msg: the error message\\- page: the URL of the page|\\- count: the number of errors\\- error\\_uv: the number of affected users\\- Ratio of affected users: the ratio obtained by dividing affected users by total UVs|'."\n" + .'|webstat.perf.bucket|Performance Sample Distribution section on the **Page Speed** page in the ARMS console|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- cfpt: the custom first paint time (FPT) of the page\\- ctti: the custom time to interact (TTI) of the page\\- dns: the amount of time consumed by DNS query\\- dom: the amount of time consumed by DOM parsing\\- fmp: the first meaningful paint (FMP) of the page\\- fpt: the FPT of the page\\- load: the amount of time consumed to completely load the page\\- ready: the time taken for the DOM to become ready\\- res: the amount of time consumed to load resources\\- ssl: the amount of time consumed to establish a Secure Sockets Layer (SSL) connection\\- t1\\\\~t10: the custom performance metrics\\- tcp: the amount of time consumed to establish a Transmission Control Protocol (TCP) connection\\- trans: the amount of time consumed to transfer the content of the page\\- ttfb: the time to first byte (TTFB)\\- tti: the TTI of the page|'."\n" + .'|webstat.perf.distribution|Performance Stacked Area Chart on the **Page Speed** page in the ARMS console|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- cfpt: the custom FPT of the page\\- ctti: the custom TTI of the page\\- dns: the amount of time consumed by DNS query\\- dom: the amount of time consumed by DOM parsing\\- fmp: the FMP of the page\\- fpt: the FPT of the page\\- load: the amount of time consumed to completely load the page\\- ready: the time taken for the DOM to become ready\\- res: the amount of time consumed to load resources\\- ssl: the amount of time consumed to establish an SSL connection\\- t1\\\\~t10: the custom performance metrics\\- tcp: the amount of time consumed to establish a TCP connection\\- trans: the amount of time consumed to transfer the content of the page\\- ttfb: the TTFB\\- tti: the TTI of the page|'."\n" + .'|webstat.resource|Resource error ranking|\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- node\\_name: the error type\\- page: the URL of the page\\- sr: the screen resolution\\- src: the resource information|count: the number of resource errors|'."\n" + .'|webstat.resource|Resource Error section on the **Overview** page in the ARMS console|\\- ct: the network connection type\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_isp: the carrier\\- ip\\_region\\_id: the ID of the region\\- node\\_name: the error type\\- page: the URL of the page\\- sr: the screen resolution\\- src: the resource information|count: the number of errors|'."\n" + .'|webstat.satisfy|Satisfaction|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- page: the URL of the page\\- sr: the screen resolution|\\- bad: frustrated, indicating that the FPT is greater than 8,000\\- good: satisfied, indicating that the FPT is smaller than 2,000\\- neutral: tolerable, indicating that the FPT is between 2,000 and 8,000\\- satisfy: Application Performance Index (Apdex)|'."\n" + .'|webstat.session|Slow loading tracking|None|\\- browser\\_version: the browser version\\- browser: the browser\\- date: the start time of the data query\\- dom: the amount of time consumed by DOM parsing\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_country: the name of the country or area\\- ip\\_region\\_id: the ID of the region\\- ip\\_region: the name of the region\\- load: the amount of time consumed to completely load the page\\- page: the URL of the page\\- sid: the session ID|'."\n" + .'|webstat.speed|Access speed|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- release: the version number\\- sr: the screen resolution\\- page: the URL of the page\\- environment: the environment|\\- avg\\_cfpt: the custom FPT of the page\\- count: the number of samples\\- avg\\_ctti: the custom TTI of the page\\- avg\\_dns: the amount of time consumed by DNS query\\- avg\\_dom: the amount of time consumed by DOM parsing\\- avg\\_fmp: the FMP of the page\\- avg\\_fpt: the FPT of the page\\- avg\\_load: the amount of time consumed to completely load the page\\- avg\\_ready: the average time taken for the DOM to become ready\\- avg\\_res: the amount of time consumed to load resources\\- avg\\_ssl: the amount of time consumed to establish an SSL connection\\- avg\\_t1\\\\~t10: the custom performance metrics\\- avg\\_tcp: the amount of time consumed to establish a TCP connection\\- avg\\_trans: the amount of time consumed to transfer the content of the page\\- avg\\_ttfb: the TTFB\\- avg\\_tti: the TTI of the page|'."\n" + .'|webstat.stable|Error rate ranking|\\- page: the URL of the page\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- sr: the screen resolution\\- msg: the error message\\- release: the version number\\- environment: the environment\\- detector\\_app\\_version: the client version\\- detector\\_app: the client app|\\- count: the number of samples\\- error\\_pv: the number of JS errors\\- rate: the JS error rate|'."\n" + .'|webstat.sum|Custom statistics: sum|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- key: the custom key\\- sr: the screen resolution|\\- count: the total number of occurrences of specified events\\- pv: the number of page views\\- sum\\_val: the total value\\- uv: the number of unique visitors|'."\n" + .'|webstat.url|Access URL|\\- detector\\_browser: the browser\\- detector\\_device: the device\\- detector\\_os: the operating system\\- ip\\_country\\_id: the ID of the country or area\\- ip\\_region\\_id: the ID of the region\\- sr: the screen resolution\\- uid\\- username: the username|\\- pv: the number of page views\\- uv: the number of unique visitors|', + 'responseParamsDescription' => '**Sample response**'."\n" ."\n" - .' ],'."\n" - .' "name":"Service",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10009,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"startat",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .' "RequestId": "687F9CB7-4798-57BF-A6EE-E6CC76******",'."\n" + .' "Data": {'."\n" + .' "PageSize": 1,'."\n" + .' "Total": 87,'."\n" + .' "Page": 1,'."\n" + .' "Items": ['."\n" + .' {'."\n" + .' "date": 1667287680000,'."\n" + .' "instanceCount": 17,'."\n" + .' "rule": "query1",'."\n" + .' "pid": "null"'."\n" + .' },'."\n" + .' {'."\n" + .' "date": 1667290680000,'."\n" + .' "instanceCount": 17,'."\n" + .' "rule": "query1",'."\n" + .' "pid": "null"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "Code": 200,'."\n" + .' "Success": true'."\n" + .' }'."\n", + 'extraInfo' => '## Browser Monitoring FAQ'."\n" ."\n" - .' ],'."\n" - .' "name":"Start time",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10010,'."\n" - .' "fieldType":"START_AT"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"endat",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" + .'* Why does an error about the RAM permissions occur when I call the API? This is because the RAM user does not have required permissions. You can grant the permissions to the RAM user. For more information, see [Use a RAM role to access resources across Alibaba Cloud accounts](~~74785~~).'."\n" ."\n" - .' ],'."\n" - .' "name":"End time",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":null,'."\n" - .' "id":10011,'."\n" - .' "fieldType":"END_AT"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"ADD",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"generatorUrl",'."\n" - .' "expression":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" - .' "mappingRuleList":['."\n" + .'* How do I obtain a list of data entries without specifying a time interval? Set the intervalInSec parameter to 2147483647.'."\n" ."\n" - .' ],'."\n" - .' "name":"Event URL",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" - .' "id":10012,'."\n" - .' "fieldType":"GENERATE_URL"'."\n" - .' }'."\n" - .']'."\n" - .'```'."\n" + .'* Why is 0 returned for all the queries?'."\n" ."\n" - .'The following table describes the fields of the preceding parameters.'."\n" + .' * Check whether the time interval that you set is too short. Make sure that the value of the intervalInSec parameter is greater than or equal to 60,000.'."\n" ."\n" - .'|Field|Description|'."\n" - .'|---|---|'."\n" - .'|RedefineType|\\- MAP: maps fields such as the alert level based on a mapping table.\\- EXTRACT: uses jsonPath to map fields from a JSON file to ARMS alerts.\\- ADD: adds content mapping to ARMS alerts.\\- CONDITION: maps fields to ARMS alerts based on the specified conditions. If the specified conditions are met, jsonPath is used to map fields from a JSON file to ARMS alerts.\\- CONCAT: concatenates multiple fields into one field and then map this field to ARMS alerts.|'."\n" - .'|MatchExpression|\\- If the RedefineType field is set to CONCAT, the value of the MatchExpression field is the delimiter that is used for concatenation.\\- If the RedefineType field is set to CONDITION, the value of the MatchExpression field is the JSON string that specifies conditions.|'."\n" - .'|FieldType|\\- LABEL: the metadata of the alert. A set of labels uniquely identifies an alert event. Alert events with the same labels are compressed into one event. Example: "alertname: alert name".\\- ANNOTATION: the additional information of the alert. Annotations are not metadata. Example: "message: alert content".\\- GENERATE\\_URL: the URL of the alert event.\\- START\\_AT: the start time of the alert event.\\- END\\_AT: the end time of the alert event.|'."\n" - .'|Expression|The conditional mapping style. An escaped string value is passed to the Expression field.|'."\n" - .'|MappingRuleList|The redefinition rules of fields.|'."\n" - .'|Name|The name of the mapping rule.|'."\n" - .'|FieldName|The name of the field.|'."\n" - .'|JsonPath|The name of the source field.|'."\n" - .'|IntegrationId|The ID of the alert integration.|'."\n" - .'|Id|The primary key ID of the table for the mapped fields.|', - ], - 'DeleteIntegrations' => [ - 'summary' => 'Deletes an alert integration.', - 'methods' => [ - 'get', + .' * Check whether the value of the regionId parameter is valid. The value depends on the region where the server that receives logs resides, rather than the region where you reside. You can identify the region ID based on the URL of the log source.'."\n" + ."\n" + .' * URL of the log source in the China (Hangzhou) region: `https://arms-retcode.aliyuncs.com/r.png?`'."\n" + .' * URL of the log source in the Singapore region: `https://arms-retcode-sg.aliyuncs.com/r.png?`'."\n" + .' * URL of the log source in the US (Silicon Valley) region: `https://retcode-us-west-1.arms.aliyuncs.com/r.png?`'."\n" + ."\n" + .'* Why does an error occur when I call the simulator or an API?'."\n" + ."\n" + .' * Check whether the regionId parameter is specified and whether the pid parameter is specified by using the Filters parameter.'."\n" + .' * Check whether you have specified a valid value of the Measures or Dimensions parameter for the metric. For more information, see the **Browser Monitoring metrics that can be queried** section in this topic.'."\n" + ."\n" + .'* Error messages and solutions'."\n" + ."\n" + .' * **Query error. Contact the administrator.**'."\n" + ."\n" + .' * Check whether the value of the Metric parameter is valid.'."\n" + .' * Check whether the value of the Measures or Dimensions parameter is valid.'."\n" + .' * Check whether the pid parameter is specified by using the Filters parameter.'."\n" + ."\n" + .' * **InvalidIntervalInSec** Check whether the value of the intervalInSec parameter exceeds the maximum value 2,147,483,647.'."\n" + ."\n" + .' * **MissingMeasures** Check whether the Measures parameter is specified.'."\n" + ."\n" + .' * **NonsequenceParameter.Dimensions**'."\n" + ."\n" + .' * Check whether the value of the Dimensions parameter is valid.'."\n" + .' * Check whether the value of the Dimensions parameter contains extra spaces.'."\n" + ."\n" + .' * **ServiceUnavailable** Check whether the value of the regionId parameter is valid.'."\n" + ."\n" + .' * **Invalid Region** Check whether the value of the regionId parameter is valid. The value depends on the region where the server that receives logs resides, rather than the region where you reside. You can identify the region ID based on the URL of the log source.'."\n" + ."\n" + .' * URL of the log source in the China (Hangzhou) region: `https://arms-retcode.aliyuncs.com/r.png?`'."\n" + .' * URL of the log source in the Singapore region: `https://arms-retcode-sg.aliyuncs.com/r.png?`'."\n" + .' * URL of the log source in the US (Silicon Valley) region: `https://retcode-us-west-1.arms.aliyuncs.com/r.png?`'."\n" + ."\n" + .'* Why are some Measures or Dimensions parameters missing from my dataset? This happens because you can specify a maximum of five Measures or Dimensions parameters. If more than five parameters are specified, no data can be returned.'."\n" + ."\n" + .'* Why does the sum of some metrics significantly decrease after they are aggregated compared with when they were not aggregated? For example, when the values of the pv parameter for the webstat.index metric are aggregated, the sum of aggregated values is significantly less than the sum of all the individual values. The API gateway admits a maximum of 10,000 data entries at a time. Additional data entries are discarded. When you attempt to aggregate more than 10,000 data entries, only the first 10,000 data entries are aggregated and the rest are discarded. This causes the aggregated result to be far less than the result of individually adding all the values. You must make sure that no more than 10,000 data entries are returned for each request. This ensures that you can obtain an accurate aggregated value.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-06-19T09:12:57.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-05-28T07:55:35.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2024-01-25T10:53:42.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-14T12:00:25.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-06-09T02:45:21.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-10-09T09:29:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2021-10-09T09:29:29.000Z', 'description' => 'Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMetricByPage'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:QueryMetricByPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"StartTime is mandatory for this action.\\",\\n \\"RequestId\\": \\"687F9CB7-4798-57BF-A6EE-E6CC76******\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"PageSize\\": 1,\\n \\"Total\\": 2,\\n \\"Page\\": 1,\\n \\"Completed\\": false,\\n \\"Items\\": [\\n []\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<QueryMetricByPageResponse>\\n <Code>200</Code>\\n <Message>StartTime is mandatory for this action.</Message>\\n <RequestId>626037F5-FDEB-45B0-804C-B3C92797****</RequestId>\\n <Success>true</Success>\\n <Data>\\n <PageSize>10</PageSize>\\n <Total>0</Total>\\n <Page>1</Page>\\n <Items/>\\n </Data>\\n</QueryMetricByPageResponse>","errorExample":""}]', + ], + 'QueryPromInstallStatus' => [ + 'summary' => 'Queries whether the Prometheus agent is installed on a cluster.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'IntegrationId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '集成ID', - 'description' => 'The ID of the alert integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'IsSuccess' => [ - 'title' => '删除成功或者失败', - 'description' => 'Indicates whether the alert integration is deleted. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', 'title' => ''], + 'Data' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'isControllerInstalled' => ['description' => 'Indicates whether the call was successful. Valid values:'."\n" + ."\n" + .'true: The call was successful. false: The call fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteIntegrationsResponse>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteIntegrationsResponse>","errorExample":""}]', - 'title' => 'DeleteIntegrations', - ], - 'ListIntegration' => [ - 'summary' => 'Views a list of alert integrations.', - 'methods' => [ - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": {\\n \\"isControllerInstalled\\": true\\n }\\n}","type":"json"}]', + 'title' => 'QueryPromInstallStatus', + 'changeSet' => [ + ['createdAt' => '2023-03-23T08:07:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPromInstallStatus'], + ], ], + 'ramActions' => [], + ], + 'QueryReleaseMetric' => [ + 'summary' => 'Queries the metrics that are provided for different versions of a specified Enterprise Distributed Application Service (EDAS) or Kubernetes application.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'IntegrationName', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'title' => '集成名称', - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'CloudMonitor integration'."\n", - ], + 'schema' => ['description' => 'The ID of the Enterprise Distributed Application Service (EDAS) or Kubernetes application.'."\n", 'type' => 'string', 'required' => true, 'example' => '8b46d03f-5947-449d-90fd-3a96c2******', 'title' => ''], ], [ - 'name' => 'IntegrationProductType', + 'name' => 'ChangeOrderId', 'in' => 'query', - 'schema' => [ - 'title' => '集成产品类型，CLOUD_MONITOR，LOG_SERVICE', - 'description' => 'The type of the alert integration. Valid values:'."\n" - ."\n" - .'* CLOUD_MONITOR: CloudMonitor'."\n" - .'* LOG_SERVICE: Log Service'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'CLOUD_MONITOR', - ], + 'schema' => ['description' => 'The ID of the change order.'."\n", 'type' => 'string', 'required' => true, 'example' => 'a341a2f2-ed07-4257-aae9-dfb1be******', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'ReleaseStartTime', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The start time of the version release.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632798686692', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'ReleaseEndTime', 'in' => 'query', - 'schema' => [ - 'title' => '条数', - 'description' => 'The number of alert integrations to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '10', - ], + 'schema' => ['description' => 'The end time of the version release.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1632798718632', 'title' => ''], ], [ - 'name' => 'IsDetail', + 'name' => 'CreateTime', 'in' => 'query', - 'schema' => [ - 'title' => '是否展示详情', - 'description' => 'Specifies whether to display the details of each alert integration:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The time when the change order was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1634005438000', 'title' => ''], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => ['description' => 'The service that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'clothservice', 'title' => ''], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the metric that you want to query.'."\n", 'type' => 'string', 'required' => false, 'example' => 'SystemContrast', 'title' => ''], + ], + [ + 'name' => 'ProxyUserId', + 'in' => 'query', + 'schema' => ['description' => 'This parameter is not in use.'."\n", 'type' => 'string', 'required' => false, 'example' => 'null', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'PageInfo' => [ - 'title' => '分页信息', - 'description' => 'The pagination information.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of alert integrations.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '条数', - 'description' => 'The number of alert integrations returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Integrations' => [ - 'description' => 'The information about each alert integration.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'IntegrationId' => [ - 'title' => '集成ID', - 'description' => 'The ID of the alert integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'IntegrationName' => [ - 'title' => '集成名称', - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'CloudMonitor integration'."\n", - ], - 'IntegrationProductType' => [ - 'title' => '集成产品类型，CLOUD_MONITOR，LOG_SERVICE', - 'description' => 'The type of the alert integration. Valid values:'."\n" - ."\n" - .'* CLOUD_MONITOR: CloudMonitor'."\n" - .'* LOG_SERVICE: Log Service'."\n", - 'type' => 'string', - 'example' => 'CLOUD_MONITOR', - ], - 'ApiEndpoint' => [ - 'title' => '接口配置url', - 'description' => 'The endpoint of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******', - ], - 'ShortToken' => [ - 'title' => '接口配置token', - 'description' => 'The authentication token of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'ymQBN******', - ], - 'State' => [ - 'title' => '是否启用，true/false', - 'description' => 'Indicates whether the alert integration was enabled. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Liveness' => [ - 'title' => '就绪', - 'description' => 'The activity of the alert integration'."\n", - 'type' => 'string', - 'example' => 'ready', - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the alert integration was created.'."\n", - 'type' => 'string', - 'example' => '2022-06-18', - ], - 'IntegrationDetail' => [ - 'title' => '集成详情对象信息', - 'description' => 'The information about the alert events.'."\n", - 'type' => 'object', - 'properties' => [ - 'Description' => [ - 'title' => '集成描述', - 'description' => 'The description of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'DuplicateKey' => [ - 'title' => '去重得字段', - 'description' => 'The fields whose values are deduplicated.'."\n", - 'type' => 'string', - 'example' => 'LABEL.alertname::LABEL.severity', - ], - 'AutoRecover' => [ - 'title' => '是否设置恢复告警事件', - 'description' => 'Indicates whether alert events are automatically cleared. Valid values:'."\n" - ."\n" - .'* true (default)'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RecoverTime' => [ - 'title' => '恢复时间', - 'description' => 'The time when alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '300', - ], - 'Stat' => [ - 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '[0,0]', - ], - ], - 'FieldRedefineRules' => [ - 'description' => 'The predefined mapped fields of the alert source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created.'."\n", - 'type' => 'object', - 'example' => '', - ], - ], - 'ExtendedFieldRedefineRules' => [ - 'description' => 'The extended mapped fields of the alert source.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The extended mapped fields are mapped to the fields of ARMS alerts.'."\n", - 'type' => 'object', - 'example' => '['."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"dimensions",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - ."\n" - .' ],'."\n" - .' "name":"dimensions",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.dimensions",'."\n" - .' "id":10013,'."\n" - .' "fieldType":"LABEL"'."\n" - .' },'."\n" - .' {'."\n" - .' "redefineType":"EXTRACT",'."\n" - .' "matchExpression":null,'."\n" - .' "fieldName":"expression",'."\n" - .' "expression":null,'."\n" - .' "mappingRuleList":['."\n" - ."\n" - .' ],'."\n" - .' "name":"expression",'."\n" - .' "integrationId":1234,'."\n" - .' "jsonPath":"$.expression",'."\n" - .' "id":10014,'."\n" - .' "fieldType":"LABEL"'."\n" - .' }'."\n" - .']', - ], - ], - 'InitiativeRecoverField' => [ - 'description' => 'The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" - ."\n" - .'> Only the Log Service alert integration supports the parameter.'."\n", - 'type' => 'string', - 'example' => '$.status', - ], - 'InitiativeRecoverValue' => [ - 'description' => 'The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" - ."\n" - .'> Only the Log Service alert integration supports the parameter.'."\n", - 'type' => 'string', - 'example' => 'ok', - ], - ], - ], - ], - 'description' => '', - ], - ], - ], - ], + 'Data' => ['description' => 'The returned metric data.'."\n", 'type' => 'string', 'example' => '{"data":{"SystemCpuUser":{"all":[{"date":1632798718000,"val":4.3277,"dim":"SystemCpuUser"},{"date":1632798733000,"val":8.1091,"dim":"SystemCpuUser"}]},"SystemMemUtil":{"all":[{"date":1632798718000,"val":73.4227,"dim":"SystemMemUtil"},{"date":1632798733000,"val":93.0977,"dim":"SystemMemUtil"}]}},"success":true}', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"PageInfo\\": {\\n \\"Total\\": 1,\\n \\"Size\\": 10,\\n \\"Page\\": 1,\\n \\"Integrations\\": [\\n {\\n \\"IntegrationId\\": 1234,\\n \\"IntegrationName\\": \\"云监控集成\\",\\n \\"IntegrationProductType\\": \\"CLOUD_MONITOR\\",\\n \\"ApiEndpoint\\": \\"https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******\\",\\n \\"ShortToken\\": \\"ymQBN******\\",\\n \\"State\\": true,\\n \\"Liveness\\": \\"ready\\",\\n \\"CreateTime\\": \\"2022-06-18\\",\\n \\"IntegrationDetail\\": {\\n \\"Description\\": \\"测试\\",\\n \\"DuplicateKey\\": \\"LABEL.alertname::LABEL.severity\\",\\n \\"AutoRecover\\": true,\\n \\"RecoverTime\\": 300,\\n \\"Stat\\": [\\n 0\\n ],\\n \\"FieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"alertname\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警名称\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.alertName\\",\\n \\"id\\": 10001,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"MAP\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"severity\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [\\n {\\n \\"mappingValue\\": \\"critical\\",\\n \\"mappingName\\": \\"P1\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"CRITICAL\\"\\n },\\n {\\n \\"mappingValue\\": \\"error\\",\\n \\"mappingName\\": \\"P2\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"WARN\\"\\n },\\n {\\n \\"mappingValue\\": \\"warning\\",\\n \\"mappingName\\": \\"P3\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"INFO\\"\\n }\\n ],\\n \\"name\\": \\"告警等级\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.triggerLevel\\",\\n \\"id\\": 10002,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"message\\",\\n \\"expression\\": \\"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警描述\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10003,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"value\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警样本值\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.curValue\\",\\n \\"id\\": 10004,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"source\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"来源\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10007,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"ADD\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"generatorUrl\\",\\n \\"expression\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"事件地址\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"id\\": 10012,\\n \\"fieldType\\": \\"GENERATE_URL\\"\\n }\\n ]\\n ],\\n \\"ExtendedFieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"dimensions\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"dimensions\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.dimensions\\",\\n \\"id\\": 10013,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"expression\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"expression\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.expression\\",\\n \\"id\\": 10014,\\n \\"fieldType\\": \\"LABEL\\"\\n }\\n ]\\n ],\\n \\"InitiativeRecoverField\\": \\"$.status\\",\\n \\"InitiativeRecoverValue\\": \\"ok\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListIntegrationResponse>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n <PageInfo>\\n <Total>1</Total>\\n <Size>10</Size>\\n <Page>1</Page>\\n <Iintegrations>\\n <IntegrationId>1234</IntegrationId>\\n <IntegrationName>云监控集成</IntegrationName>\\n <IntegrationProductType>CLOUD_MONITOR</IntegrationProductType>\\n <ApiEndpoint>https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******</ApiEndpoint>\\n <ShortToken>ymQBN******</ShortToken>\\n <State>true</State>\\n <Liveness>ready</Liveness>\\n <CreateTime>2022-06-18</CreateTime>\\n <IntegrationDetail>\\n <Description>测试</Description>\\n <DuplicateKey>LABEL.alertname::LABEL.severity</DuplicateKey>\\n <AutoRecover>true</AutoRecover>\\n <RecoverTime>300</RecoverTime>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>alertname</fieldName>\\n <expression/>\\n <name>告警名称</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.alertName</jsonPath>\\n <id>10001</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>MAP</redefineType>\\n <matchExpression/>\\n <fieldName>severity</fieldName>\\n <expression/>\\n <mappingRuleList>\\n <mappingValue>critical</mappingValue>\\n <mappingName>P1</mappingName>\\n <mappingType>MAP</mappingType>\\n <originValue>CRITICAL</originValue>\\n </mappingRuleList>\\n <mappingRuleList>\\n <mappingValue>error</mappingValue>\\n <mappingName>P2</mappingName>\\n <mappingType>MAP</mappingType>\\n <originValue>WARN</originValue>\\n </mappingRuleList>\\n <mappingRuleList>\\n <mappingValue>warning</mappingValue>\\n <mappingName>P3</mappingName>\\n <mappingType>MAP</mappingType>\\n <originValue>INFO</originValue>\\n </mappingRuleList>\\n <name>告警等级</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.triggerLevel</jsonPath>\\n <id>10002</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>message</fieldName>\\n <expression>{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。</expression>\\n <name>告警描述</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10003</id>\\n <fieldType>ANNOTATION</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>value</fieldName>\\n <expression/>\\n <name>告警样本值</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.curValue</jsonPath>\\n <id>10004</id>\\n <fieldType>ANNOTATION</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>imageUrl</fieldName>\\n <expression/>\\n <name>告警图片</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10005</id>\\n <fieldType>ANNOTATION</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>check</fieldName>\\n <expression/>\\n <name>检查项</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10006</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>source</fieldName>\\n <expression/>\\n <name>来源</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10007</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>class</fieldName>\\n <expression/>\\n <name>分类</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10008</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>service</fieldName>\\n <expression/>\\n <name>服务</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10009</id>\\n <fieldType>LABEL</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>startat</fieldName>\\n <expression/>\\n <name>开始时间</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10010</id>\\n <fieldType>START_AT</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>endat</fieldName>\\n <expression/>\\n <name>结束时间</name>\\n <integrationId>1234</integrationId>\\n <jsonPath/>\\n <id>10011</id>\\n <fieldType>END_AT</fieldType>\\n </FieldRedefineRules>\\n <FieldRedefineRules>\\n <redefineType>ADD</redefineType>\\n <matchExpression/>\\n <fieldName>generatorUrl</fieldName>\\n <expression>https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}</expression>\\n <name>事件地址</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}</jsonPath>\\n <id>10012</id>\\n <fieldType>GENERATE_URL</fieldType>\\n </FieldRedefineRules>\\n <ExtendedFieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>dimensions</fieldName>\\n <expression/>\\n <name>dimensions</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.dimensions</jsonPath>\\n <id>10013</id>\\n <fieldType>LABEL</fieldType>\\n </ExtendedFieldRedefineRules>\\n <ExtendedFieldRedefineRules>\\n <redefineType>EXTRACT</redefineType>\\n <matchExpression/>\\n <fieldName>expression</fieldName>\\n <expression/>\\n <name>expression</name>\\n <integrationId>1234</integrationId>\\n <jsonPath>$.expression</jsonPath>\\n <id>10014</id>\\n <fieldType>LABEL</fieldType>\\n </ExtendedFieldRedefineRules>\\n </IntegrationDetail>\\n </Iintegrations>\\n </PageInfo>\\n</ListIntegrationResponse>","errorExample":""}]', - 'title' => 'ListIntegration', - ], - 'CreateOrUpdateAlertRule' => [ - 'summary' => 'Creates or modifies an alert rule.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"{\\\\\\"data\\\\\\":{\\\\\\"SystemCpuUser\\\\\\":{\\\\\\"all\\\\\\":[{\\\\\\"date\\\\\\":1632798718000,\\\\\\"val\\\\\\":4.3277,\\\\\\"dim\\\\\\":\\\\\\"SystemCpuUser\\\\\\"},{\\\\\\"date\\\\\\":1632798733000,\\\\\\"val\\\\\\":8.1091,\\\\\\"dim\\\\\\":\\\\\\"SystemCpuUser\\\\\\"}]},\\\\\\"SystemMemUtil\\\\\\":{\\\\\\"all\\\\\\":[{\\\\\\"date\\\\\\":1632798718000,\\\\\\"val\\\\\\":73.4227,\\\\\\"dim\\\\\\":\\\\\\"SystemMemUtil\\\\\\"},{\\\\\\"date\\\\\\":1632798733000,\\\\\\"val\\\\\\":93.0977,\\\\\\"dim\\\\\\":\\\\\\"SystemMemUtil\\\\\\"}]}},\\\\\\"success\\\\\\":true}\\",\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\"\\n}","type":"json"}]', + 'title' => 'QueryReleaseMetric', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryReleaseMetric'], + ], ], + 'ramActions' => [], + ], + 'RemoveAliClusterIdsFromPrometheusGlobalView' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '104428', - 'abilityTreeNodes' => [ - 'FEATUREarms20UGKV', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AlertId', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警规则ID', - 'description' => 'The ID of the alert rule.'."\n" - ."\n" - .'* If you do not specify this parameter, a new alert rule is created.'."\n" - .'* If you specify this parameter, the specified alert rule is modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '546xxx', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AlertName', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警规则名称', - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Alert Rule Demo', - ], + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'title' => '地域', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'global-v2-cn-1670100631025794-amaykca4', 'title' => ''], ], [ - 'name' => 'AlertType', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警规则类型', - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'* APPLICATION_MONITORING_ALERT_RULE: an alert rule for Application Monitoring.'."\n" - .'* BROWSER_MONITORING_ALERT_RULE: an alert rule for Browser Monitoring.'."\n" - .'* PROMETHEUS_MONITORING_ALERT_RULE: an alert rule for Managed Service for Prometheus.'."\n" - .'* XTRACE_MONITORING_ALERT_RULE: an alert rule for Managed Service for OpenTelemetry.'."\n" - .'* EBPF_MONITORING_ALERT_RULE: an alert rule for Application Monitoring eBPF Edition.'."\n" - .'* RUM_MONITORING_ALERT_RULE: an alert rule for Real User Monitoring.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* PROMETHEUS_MONITORING_ALERT_RULE'."\n" - .'* APPLICATION_MONITORING_ALERT_RULE'."\n" - .'* BROWSER_MONITORING_ALERT_RULE'."\n" - .'* prometheus monitoring alert'."\n" - .'* application monitoring alert'."\n" - .'* browser monitoring alert'."\n" - .'* XTRACE_MONITORING_ALERT_RULE'."\n" - .'* EBPF_MONITORING_ALERT_RULE'."\n" - .'* RUM_MONITORING_ALERT_RULE'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'APPLICATION_MONITORING_ALERT_RULE', - 'enum' => [ - 'PROMETHEUS_MONITORING_ALERT_RULE', - 'APPLICATION_MONITORING_ALERT_RULE', - 'BROWSER_MONITORING_ALERT_RULE', - 'prometheus monitoring alert', - 'application monitoring alert', - 'browser monitoring alert', - 'XTRACE_MONITORING_ALERT_RULE', - 'EBPF_MONITORING_ALERT_RULE', - 'RUM_MONITORING_ALERT_RULE', - ], - ], + 'name' => 'ClusterIds', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of clusters. Separate multiple IDs with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', 'title' => ''], ], - [ - 'name' => 'AlertStatus', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* RUNNING (default)'."\n" - .'* STOPPED'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Msg' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Info' => ['description' => 'The Info-level information.'."\n", 'type' => 'string', 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误）}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'NotifyStrategy', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The notification policy.'."\n" - ."\n" - .'* If you set this parameter to null, no notification policy is specified. After you create an alert rule, you can create a notification policy and specify match rules and match conditions. For example, you can specify the name of the alert rule as the match condition. When the alert rule is triggered, an alert event is generated and an alert notification is sent to the contacts or contact groups that are specified in the notification policy.'."\n" - .'* To specify a notification policy, set this parameter to the ID of the notification policy. Application Real-Time Monitoring Service (ARMS) automatically adds a match rule to the notification policy and specifies the ID of the alert rule as the match condition. The name of the alert rule is also displayed. This way, the alert events that are generated based on the alert rule can be matched by the specified notification policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '569xxx', - ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'RemoveAliClusterIdsFromPrometheusGlobalView', + 'summary' => 'Removes data sources from a global aggregation instance in Managed Service for Prometheus.', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAliClusterIdsFromPrometheusGlobalView'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误）}\\"\\n },\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'RemoveSourcesFromPrometheusGlobalView' => [ + 'summary' => 'Removes data sources from a global aggregation instance in Managed Service for Prometheus. You can delete only data sources that are not from Alibaba Cloud.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Pids', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The process ID (PID) that is associated with the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["b590lhguqs@40d8deedfa9******"]', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'AutoAddNewApplication', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether to apply the alert rule to new applications that are created in Application Monitoring or Browser Monitoring. Valid values:'."\n" - ."\n" - .'* `true`: enables the health check feature.'."\n" - .'* `false`: disables the automatic backup feature.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'MetricsType', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The metric type of the Application Monitoring or Browser Monitoring alert rule. For more information, see the following table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'jvm', - ], + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], ], [ - 'name' => 'Filters', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The filter conditions of the Application Monitoring or Browser Monitoring alert rule. Format:'."\n" - ."\n" - .' "DimFilters": [ '."\n" - .' { '."\n" - .' "FilterOpt": "ALL",'."\n" - .' "FilterValues": [], //The value of the filter condition.'."\n" - .' "FilterKey": "rootIp" //The key of the filter condition.'."\n" - .' }'."\n" - .' ]'."\n" - ."\n" - .'Valid values of **FilterOpt**:'."\n" - ."\n" - .'* STATIC: matches the value of the specified dimension.'."\n" - .'* ALL: traverses all dimension values. Dynamic thresholds do not support traversal.'."\n" - .'* DISABLE: aggregates the values of all dimensions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{"DimFilters": [ { "FilterOpt": "ALL", "FilterValues": [], "FilterKey": "rootIp" } ] }', - ], + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the global aggregation instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', 'title' => ''], ], [ - 'name' => 'AlertRuleContent', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The content of the Application Monitoring or Browser Monitoring alert rule. The following code provides an example of the **AlertRuleContent** parameter. For more information about the meaning of each field, see the supplementary description.'."\n" - ."\n" - .'```json'."\n" - .'{ '."\n" - .' "Condition": "OR",'."\n" - .' "AlertRuleItems": ['."\n" - .' { "Operator": "CURRENT_LTE",'."\n" - .' "MetricKey": "appstat.jvm.threadcount",'."\n" - .' "Value": 1000,'."\n" - .' "Aggregate": "AVG",'."\n" - .' "N": 10,'."\n" - .' "Tolerability": 169'."\n" - .' } '."\n" - .' ] '."\n" - .' }'."\n" - .'```'."\n" - ."\n" - .'> The filter conditions specified by the **AlertRuleItems.MetricKey** field depends on the value of the **MetricsType** parameter. For more information about the types of metrics supported by Application Monitoring and Browser Monitoring and the alert rule fields corresponding to each metric, see the supplementary description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Condition": "OR", "AlertRuleItems": [ { "Operator": "CURRENT_LTE", "MetricKey": "appstat.jvm.threadcount", "Value": 1000, "Aggregate": "AVG", "N": 1 } ] }', - ], + 'name' => 'SourceNames', + 'in' => 'query', + 'schema' => ['description' => 'The list of custom data sources. You can specify multiple data sources and separate them with commas (,).'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'localPrometheusClusterName,testCumterPrometheusName', 'title' => ''], ], - [ - 'name' => 'AlertCheckType', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The alert check type of the Prometheus alert rule. Valid values:'."\n" - ."\n" - .'* STATIC: a static threshold value. If you set the parameter to STATIC, you must specify the **MetricsKey** parameter. For more information, see the **Correspondence between AlertGroup and MetricsKey for Prometheus Service** table.'."\n" - .'* CUSTOM: a custom PromQL statement. If you set the parameter to CUSTOM, you must specify the **PromQL**, **Duration**, and **Message** parameters to create a Prometheus alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'STATIC', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'True', 'title' => ''], + 'Msg' => ['description' => 'The additional information.'."\n", 'type' => 'string', 'example' => 'OK', 'title' => ''], + 'Info' => ['description' => 'The Info-level information.'."\n", 'type' => 'string', 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id}', 'title' => ''], + ], + 'title' => '', + 'example' => '', + ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to query logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The status code. The HTTP 200 status code indicates a successful request, while others indicate error conditions.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'ClusterId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the monitored cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', - ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'RemoveSourcesFromPrometheusGlobalView', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:11.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-20T02:30:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSourcesFromPrometheusGlobalView'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"Msg\\": \\"OK\\",\\n \\"Info\\": \\"{regionId: 实例所属region, globalViewClusterId: 实例Id}\\"\\n },\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'RestartEnvironmentFeature' => [ + 'summary' => 'Restarts a feature.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'AlertGroup', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert contact group ID of the Prometheus alert rule. Valid values:'."\n" - ."\n" - .'* \\-1: custom PromQL'."\n" - .'* 1: Kubernetes load'."\n" - .'* 15: Kubernetes node'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '-1', - ], + 'AK' => [], ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'PromQL', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The PromQL statement of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', - ], + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the environment.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'env-xxx'], ], [ - 'name' => 'Duration', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The duration of the Prometheus alert rule, in minutes, in the range of [0,1440].', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Level', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The severity level of the Prometheus alert rule.'."\n" - ."\n" - .'* P1: Alert notifications are sent for major issues that affect the availability of core business, have a huge impact, and may lead to serious consequences.'."\n" - .'* P2: Alert notifications are sent for service errors that affect the system availability with relatively limited impact.'."\n" - .'* P3: Alert notifications are sent for issues that may cause service errors or negative effects, or alert notifications for services that are relatively less important.'."\n" - .'* P4: Alert notifications are sent for low-priority issues that do not affect your business.'."\n" - .'* Default: Alert notifications are sent regardless of alert levels.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P2', - ], + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => ['description' => 'The feature name. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check.', 'type' => 'string', 'required' => true, 'title' => '', 'example' => 'metric-agent'], ], - [ - 'name' => 'Message', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The alert message of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Namespace: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / Container: {{$labels.container}} Memory usage exceeds 80%. Current value: {{ printf \\\\\\\\\\"%.2f\\\\\\\\\\" $value }}%'."\n", + 'title' => '', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request failed.', 'type' => 'string', 'example' => 'success.', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values: true false', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'Labels', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The tags of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[ { "Value": "cms_polardb", "Name": "_aliyun_cloud_product" } ]', - ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'RestartEnvironmentFeature', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartEnvironmentFeature'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2983BEF7-4A0D-47A2-94A2-8E9C5E63****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success.\\",\\n \\"Success\\": true,\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + ], + 'SaveTraceAppConfig' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Annotations', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The annotations of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '\\[ { "Value": "PolarDB slow queries", "Name": "\\_aliyun_display_name" }'."\n", - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'MetricsKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The alert metrics. If you set the **AlertCheckType** parameter to **STATIC** when you create a Prometheus alert rule, you must specify the **MetricsKey** parameter.'."\n" - ."\n" - .'> Alert metrics vary depending on the value of the **AlertGroup** parameter. For more information about the correspondence between **AlertGroup** and **MetricsKey**, see the supplementary description.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pop.status.error', - ], + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The process ID (PID) of the application.'."\n" + ."\n" + .'Log on to the ARMS console. In the left-side navigation pane, choose **Application Monitoring** > **Application List**. On the Application List page, click the name of an application. The URL in the address bar contains the PID of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is xxx%4074xxx, you must replace %40 with an at sign (@) to obtain xxx@74xxx.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'a2n80plglh@745eddxxx', 'title' => ''], ], [ - 'name' => 'Tags', - 'in' => 'formData', + 'name' => 'Settings', + 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The list of tags.'."\n", + 'description' => 'The settings of Application Monitoring.'."\n", 'type' => 'array', 'items' => [ 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'owner', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'John', - ], + 'Key' => ['description' => 'The key of the settings that you want to modify. For more information about the supported settings, see the following sections.'."\n" + ."\n" + .'* Trace sampling settings'."\n" + .'* Agent switch settings'."\n" + .'* Threshold settings'."\n" + .'* Advanced settings'."\n" + .'* Thread settings'."\n" + .'* Memory snapshot settings'."\n" + .'* URL convergence settings'."\n" + .'* Business log association settings'."\n", 'type' => 'string', 'required' => false, 'example' => 'sampling.enable', 'title' => ''], + 'Value' => ['description' => 'The value of the settings that you want to modify. For more information about the supported settings, see the following sections.'."\n" + ."\n" + .'* Trace sampling settings'."\n" + .'* Agent switch settings'."\n" + .'* Threshold settings'."\n" + .'* Advanced settings'."\n" + .'* Thread settings'."\n" + .'* Memory snapshot settings'."\n" + .'* URL convergence settings'."\n" + .'* Business log association settings'."\n", 'type' => 'string', 'required' => false, 'example' => 'true', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 21, + 'maxItems' => 256, + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'MarkTags', - 'in' => 'formData', - 'style' => 'repeatList', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Application Tags. Used for application monitoring alert rules, to filter applications associated with alert rules.', - 'type' => 'array', - 'items' => [ - 'description' => 'Associated Application Tags.', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The Tag Key.', - 'type' => 'string', - 'required' => false, - 'example' => 'service', - ], - 'Value' => [ - 'description' => 'The Tag Value.', - 'type' => 'string', - 'required' => false, - 'example' => 'proudct', - ], - ], - 'required' => false, + 'type' => 'object', + 'properties' => [ + 'Data' => ['description' => 'Indicates whether the call was successful.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code. 2XX indicates that the request was successful. 3XX indicates that the request was redirected. 4XX indicates that a request error occurred. 5XX indicates that a server error occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'required' => false, - 'maxItems' => 100, + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ParameterTraceAppSettingKeyIllegal', 'errorMessage' => 'The application configuration key is invalid.', 'description' => 'The application configuration key is invalid.'], + ['errorCode' => 'ParameterTraceAppSettingValueIllegal', 'errorMessage' => 'The application configuration value is invalid.', 'description' => 'The application configuration value is invalid.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'InterPlease try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => ''], + ], + 404 => [ + ['errorCode' => 'AppNotExist', 'errorMessage' => 'The application does not exist.', 'description' => 'The application does not exist.'], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<SaveTraceAppConfigResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <Data>success</Data>\\n</SaveTraceAppConfigResponse>","errorExample":""}]', + 'title' => 'SaveTraceAppConfig', + 'summary' => 'Modifies the settings of Application Monitoring, such as trace sampling and agent switch settings.', + 'requestParamsDescription' => '**Trace sampling settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|sampling.enable|Specifies whether to turn on the sampling switch.|Valid values:\\- `true`: turns on the sampling switch\\- `false`: turns off the sampling switch|'."\n" + .'|sampling.rate|The sampling rate.|Valid values: 0 to 100. Default value: 10.|'."\n" + ."\n" + .'**Agent switch settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|enable|Specifies whether to turn on the agent switch.|Valid values:\\- `true`: turns on the agent switch\\- `false`: turns off the agent switch|'."\n" + ."\n" + .'**Threshold settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|thresholds.limit|The throttling threshold.|Default value: 100.|'."\n" + .'|thresholds.interface|The threshold of response time for API calls.|Default value: 500. Unit: ms.|'."\n" + .'|thresholds.sql|The threshold of the amount of time consumed by slow SQL queries.|Default value: 500. Unit: ms.|'."\n" + ."\n" + .'**Advanced settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|defined.excludeurl|The invalid API calls that you want to exclude.|Separate multiple API calls with commas (,).Default value: /\\*\\*/\\*.jpg,/\\*\\*/\\*.png,/\\*\\*/\\*.js,/\\*\\*/\\*.jpeg.Example: /service/taobao,/service/status.|'."\n" + .'|callstack.maxLength|The maximum length of method stacks.|Default value: 128. Maximum value: 400.|'."\n" + .'|exception.stacktrace|The stack depth based on which the system identifies the same type of exceptions.|Default value: 2. The system identifies the same type of exceptions based on the specified stack depth. If you change the value, unexpected statistics may occur. **Proceed with caution**.|'."\n" + .'|callsql.maxLength|The maximum length of collected SQL statements.|A collected SQL statement must be 256 to 4096 characters in length. Default value: 1024.|'."\n" + .'|jdbc.tracesqlbindvalue|Specifies whether to capture variables bound to the PrepareStatement parameter.|Valid values:\\-`true`: turns on the switch of capturing variables bound to the PrepareStatement parameter\\- `false`: turns off the switch of capturing variables bound to the PrepareStatement parameter|'."\n" + .'|jdbc.tracesqlraw|Specifies whether to capture raw SQL statements.|Valid values:\\- `true`: turns on the switch of capturing raw SQL statements\\- `false`: turns off the switch of capturing raw SQL statements|'."\n" + .'|exception.whitelist|The exceptions that you want to exclude.|The value must be a regular expression that specifies the name of an exception category. Separate multiple exception categories with commas (,). Example: java.lang.InterrupetedException,java.lang.IndexOutOfBoundsException. The exceptions of the categories that you specify are not displayed in the charts on the Application Details and Exceptions Diagnosis pages.|'."\n" + .'|error.skip|The errors that you want to exclude.|By default, all HTTP status codes greater than 400 are counted as errors. To ignore specific HTTP status codes greater than 400, you can specify them as the value of this key. This way, they are not counted as errors. Separate multiple HTTP status codes with commas (,). Examples: 429 and 429,512. This key is supported by agent version 2.5.7.2 or later.|'."\n" + .'|compress.enable|Specifies whether to turn on the trace compression switch.|Valid values:\\- `true`: turns on the trace compression switch\\- `false`: turns off the trace compression switch|'."\n" + .'|param.maxLength|The maximum length of request parameters.|Default value: 512. If the value is higher than the default value, additional system resources are consumed. **Exercise caution when you configure this key**.|'."\n" + .'|quantile.enable|Specifies whether to turn on the quantile statistics switch.|Valid values:\\- `true`: turns on the quantile statistics switch\\- `false`: turns off the quantile statistics switch|'."\n" + .'|threadpoolmonitor.enable|Specifies whether to enable thread pool and connection pool monitoring.|**The configuration of this key takes effect after the application is restarted**.Valid values:\\- `true`: enables thread pool and connection pool monitoring\\- `false`: disables thread pool and connection pool monitoring|'."\n" + .'|async.autoTransmit|Specifies whether to turn on the automatic asynchronous propagation switch.|**This key is valid only when the agent version is 2.8.3 or later**.**The configuration of this key takes effect after the application is restarted**. This feature encapsulates the Runnable and Callable tasks that are submitted to the thread pool to propagate the context. Potential risks may arise. **Exercise caution when you configure this key**.Valid values:\\-`true`: turns on the automatic asynchronous propagation switch\\- `false`: turns off the automatic asynchronous propagation switch|'."\n" + .'|thread.match.package|The name of the package for asynchronous propagation.|**This key is valid only when the agent version is 2.7.1.3 or later**.**The configuration of this key takes effect after the application is restarted**. When a Runnable, Callable, Supplier under the specified package is created, the trace context is automatically captured and propagated to the new thread. Separate multiple package names with commas (,).|'."\n" + .'|responseInject.enable|Specifies whether to turn on the switch of returning the trace ID in the request.|Valid values:\\- `true`: turns on the switch\\- `false`: turns off the switch|'."\n" + ."\n" + .'**Thread settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|tprof.enableThreadProfiler|Specifies whether to turn on the main switch of thread profiling.|Valid values:\\- `true`: turns on the switch\\- `false`: turns off the switchIf you turn on this switch, the native method stacks of slow API calls are automatically saved.|'."\n" + .'|tprof.threadProfilerSlowInteractionRt|The threshold of the amount of time consumed by slow API calls.|Default value: 2000. If the amount of time consumed by slow API calls exceeds the threshold, thread profiling is enabled. We recommend that you set the value to the 99th percentile of the amount of time consumed. If you set a value smaller than 2000, the CPU consumption is increased. We recommend that you set a value greater than or equal to 500.|'."\n" + .'|tprof.enableThreadStackRecorder|Specifies whether to enable thread profiling for method stacks.|Valid values:\\- `true`: enables thread profiling for method stacks\\- `false`: disables thread profiling for method stacksIf you enable thread profiling, method stacks are collected every 5 minutes.|'."\n" + ."\n" + .'**Business log association settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|logging.enable|Specifies whether to turn on the switch to associate trace IDs with business logs.|Valid values:\\- `true`: turns on the switch\\- `false`: turns off the switchIf you turn on this switch, trace IDs are automatically generated in the business logs of an application. This setting takes effect after you restart the application. Logging utilities such as Log4j, Log4j2, and Logback are supported. You must add %X{EagleEye-TraceID} to the log layout to generate trace IDs.|'."\n" + .'|SLS.project|The Simple Log Service project that stores the business logs generated in the current region.|You can specify the name of a Simple Log Service project that stores the business logs generated in the current region.|'."\n" + .'|SLS.logStore|The Simple Log Service Logstore that stores the business logs generated in the current region.|You can specify the name of a Simple Log Service Logstore that stores the business logs generated in the current region.|'."\n" + .'|SLS.index|The type of indexes of business logs generated in the current region.|Valid values:\\- If you want to use full-text indexes, do not set this key.\\- If you want to use a field-specific index, set the value to the field name. Example: **SLS.index: tag**.For more information about the differences between field-specific indexes and full-text indexes, see [Configure indexes](~~90732~~).|'."\n" + ."\n" + .'**URL convergence settings**'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|convergence.enable|Specifies whether to enable the URL convergence feature.|Valid values:\\- `true`: enables the URL convergence feature\\- `false`: disables the URL convergence feature|'."\n" + .'|convergence.minServerSize|The convergence threshold.|If the threshold is exceeded, convergence is performed.|'."\n" + .'|convergence.pattern|The regular expression of convergence rules.|You can use regular expressions to configure convergence rules. Separate multiple regular expressions with commas (,). Enter a URL in the original text to indicate that the URL is not converged. Example: /service/(.\\*?)/demo.|'."\n" + ."\n" + .'**Arthas diagnostics settings**'."\n" + ."\n" + .'****Note: The Arthas diagnostics settings take effect only when the agent version is 2.7.1.3 or later. For more information about other prerequisites, see [Arthas diagnostics](~~300078~~).****'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|arthas.enable|Specifies whether to turn on the Arthas switch.|Valid values:\\- `true`: turns on the Arthas switch\\- `false`: turns off the Arthas switch|'."\n" + .'|arthas.enableIps|The IP addresses for which the Arthas diagnostics feature is enabled.|If you configure this key, the Arthas diagnostics feature takes effect only on the specified IP addresses. If you do not configure this key, the Arthas diagnostics feature takes effect on all IP addresses by default. Separate multiple IP addresses with commas (,).|'."\n" + ."\n" + .'**Continuous profiling settings**'."\n" + ."\n" + .'****Note: The continuous profiling settings take effect only when the agent version is 2.7.3.5 or later. For more information about other prerequisites, see [Continuous profiling](~~473143~~).****'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|cp.enable|Specifies whether to turn on the continuous profiling switch.|Valid values:\\- `true`: turns on the continuous profiling switch\\- `false`: turns off the continuous profiling switch\\* If you turn on this switch, you must configure the IP addresses on which the switch takes effect. Otherwise, the switch does not take effect. You can configure the IP addresses in the following two modes.|'."\n" + ."\n" + .'|||||'."\n" + .'|---|---|---|---|'."\n" + .'|Mode|Key|Description|Value|'."\n" + .'|IP address whitelist|cp.allowIPs|IP address whitelist|The IP addresses of the instances for which continuous profiling is enabled. Separate multiple IP addresses with commas (,).Example: 192.168.0.1,192.168.0.2|'."\n" + .'|cp.allowNetwork|CIDR block|Specify an empty string. Otherwise, continuous profiling does not work properly.|'."\n" + .'|CIDR block|cp.allowIPs|IP address whitelist|Specify an empty string. Otherwise, continuous profiling does not work properly.|'."\n" + .'|cp.allowNetwork|CIDR block|The CIDR block of the instances for which continuous profiling is enabled.Example: 192.168.2.0/24/24|'."\n" + ."\n" + .'**Data masking settings** ****Note: The data masking settings take effect only when the agent version is 2.9.0 or later.****'."\n" + ."\n" + .'|Key|Description|Value|'."\n" + .'|---|---|---|'."\n" + .'|sanitizer.enable|Specifies whether to turn on the data masking switch.|Valid values:\\- `true`: turns on the data masking switch\\- `false`: turns off the data masking switch|'."\n" + .'|sanitizer.keys|The data masking rules.|You can specify rules for data masking, as shown in the example. The specified rules are used as keys for exact matching. For example, if you specify password, the rule is equivalent to the regular expression .\\*password.\\*. The keys are not case-sensitive. Separate multiple rules with commas (,).Example: password,secret,key,token, and credentials|', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-11-06T08:26:28.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-14T12:00:25.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2023-08-03T03:12:48.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-04-18T06:43:16.000Z', 'description' => 'Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + ], + 'SearchAlertContact' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'DataConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Data Configuration. The dataRevision field specifies the data repair method when there is no data for the metric.'."\n" - ."\n" - .'- Fill with zero: 0'."\n" - .'- Fill with one: 1'."\n" - .'- Fill with null: 2 (default, does not trigger an alarm)', - 'type' => 'string', - 'required' => false, - 'example' => '{'."\n" - .' "dataRevision": 2'."\n" - .'}', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'Notice', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The effective time and notification time. This parameter is used to be compatible with the old version of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'John Doe', 'title' => ''], ], [ - 'name' => 'AlertPiplines', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The configuration of the alert sending channel. This parameter is used to be compatible with the old version of the rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '-', - ], + 'name' => 'Phone', + 'in' => 'query', + 'schema' => ['description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1381111*****', 'title' => ''], ], [ - 'name' => 'NotifyMode', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The notification mode. You can specify normal mode or simple mode.'."\n" - ."\n" - .'* DIRECTED_MODE'."\n" - .'* NORMAL_MODE'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [], - 'example' => 'NORMAL_MODE', - 'default' => 'NORMAL_MODE', - 'enum' => [ - 'DIRECTED_MODE', - 'NORMAL_MODE', - ], - ], + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'someone@example.com', 'title' => ''], ], [ - 'name' => 'Product', - 'in' => 'formData', - 'schema' => [ - 'title' => '创建Prometheus告警规则时传入，后台会校验是否存在此产品，用于区分云产品过滤查询', - 'description' => 'The product code. If you specify this parameter when you create a Prometheus alert rule, the backend checks whether the product exists.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'clickhouse', - ], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AutoAddTargetConfig', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The configurations that are automatically appended to monitor the application based on the specified alert rule.'."\n" - ."\n" - .'* autoAddMatchType:'."\n" - ."\n" - .' the matching mode. Valid values: REGULAR and NOT_REGULAR.'."\n" - ."\n" - .'* autoAddMatchExp: the regular expression'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{\\"autoAddMatchType\\":\\"REGULAR\\",\\"autoAddMatchExp\\":\\".*cbw.*\\"}', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'CheckCycle', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The interval for checking the alerts in Managed Service for Prometheus.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'aliyunLang', - 'in' => 'formData', - 'schema' => [ - 'type' => 'string', - ], + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'example' => '[12345]', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned data.'."\n", + 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', - ], - 'AlertRule' => [ - 'description' => 'The details of the alert rule.'."\n", + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', 'title' => ''], + 'PageBean' => [ + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'AlertId' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5510445', - 'title' => '', - ], - 'AlertName' => [ - 'title' => '告警规则名称', - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'arms-test', - ], - 'UserId' => [ - 'title' => '用户UID', - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1131971649******', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AlertType' => [ - 'title' => '告警规则类型', - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'* APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring'."\n" - .'* BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring'."\n" - .'* PROMETHEUS_MONITORING_ALERT_RULE: alert rule for Prometheus Service'."\n", - 'type' => 'string', - 'example' => 'APPLICATION_MONITORING_ALERT_RULE', - ], - 'AlertStatus' => [ - 'title' => '告警规则状态', - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* STOPPED'."\n" - .'* PAUSED'."\n" - ."\n" - .'> The PAUSED status indicates that the alert rule is abnormal and is actively paused by the system. The alert rule may be paused because that it is not unique or the associated cluster has been deleted.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => 'The timestamp generated when the alert rule was created. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641438611000', - ], - 'UpdatedTime' => [ - 'title' => '更新时间', - 'description' => 'The timestamp generated when the alert rule was updated. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1641438611000', - ], - 'Extend' => [ - 'title' => '扩展字段', - 'description' => 'The extended fields.'."\n", - 'type' => 'string', - 'example' => '{\\\\"alarmContext\\\\":\\\\"{\\\\\\\\\\"content\\\\\\\\\\":\\\\\\\\Alert name: $Alert name\\\\\\\\\\\\nFilter condition: $Filter condition\\\\\\\\\\\\nAlert time: $Alert time\\\\\\\\\\\\nAlert content: $Alert content\\\\\\\\\\\\nNote: The alert persists before you receive an email that reminds you to clear the alert. You will be reminded of the alert again 24 hours later. \\\\\\\\\\",\\\\\\\\\\"subTitle\\\\\\\\\\":\\\\\\\\\\"\\\\\\\\\\"}\\\\",\\\\"alertWays\\\\":\\\\"\\[0,1]\\\\",\\\\"contactGroupIds\\\\":\\\\"381,5075\\\\",\\\\"notice\\\\":\\\\"{\\\\\\\\\\"endTime\\\\\\\\\\":1480607940000,\\\\\\\\\\"noticeEndTime\\\\\\\\\\":1480607940000,\\\\\\\\\\"noticeStartTime\\\\\\\\\\":1480521600000,\\\\\\\\\\"startTime\\\\\\\\\\":1480521600000}\\\\"}'."\n", - ], - 'NotifyStrategy' => [ - 'title' => '通知策略ID', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'ALERT_MANAGER', - ], - 'Pids' => [ - 'title' => '应用监控/前端监控-告警关联应用ID', - 'description' => 'The process ID (PID) that was associated with the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The PID of the application.'."\n", - 'type' => 'string', - 'example' => 'b590lhguqs@40d8deedfa9******', - ], - ], - 'AutoAddNewApplication' => [ - 'title' => '应用监控/前端监控-是否开启新创建应用追加到此告警规则', - 'description' => 'Indicates whether the alert rule was applied to new applications that were created in Application Monitoring or Browser Monitoring. Valid values:'."\n" - ."\n" - .'* `true`: enables the health check feature.'."\n" - .'* `false`: disables the automatic backup feature.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'MetricsType' => [ - 'title' => '应用监控/前端监控-告警指标类型', - 'description' => 'The metric type of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'string', - 'example' => 'JVM', - ], - 'AlertRuleContent' => [ - 'title' => '应用监控/前端监控-告警规则内容', - 'description' => 'The content of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Condition' => [ - 'title' => '应用监控/前端监控-多个告警条件触发逻辑', - 'description' => 'The relationship between multiple alert conditions that were specified for the Application Monitoring or Browser Monitoring alert rule. Valid values:'."\n" - ."\n" - .'* OR: meets any of the specified conditions.'."\n" - .'* AND: meets all the specified conditions.'."\n", - 'type' => 'string', - 'example' => '"|"', - ], - 'AlertRuleItems' => [ - 'title' => '应用监控/前端监控-告警条件', - 'description' => 'The trigger conditions of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the alert condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'N' => [ - 'title' => '应用监控/前端监控-最近N分钟', - 'description' => 'Indicates the last N minutes.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '1', - ], - 'MetricKey' => [ - 'title' => '应用监控/前端监控-具体告警条件的指标', - 'description' => 'The metric of the alert condition.'."\n", - 'type' => 'string', - 'example' => 'appstat.jvm.non_heap_used'."\n", - ], - 'Aggregate' => [ - 'title' => '应用监控/前端监控-聚合方式', - 'description' => 'The aggregation method of the alert condition. Valid values:'."\n" - ."\n" - .'* AVG: calculates the average value'."\n" - .'* SUM: calculates the total value'."\n" - .'* MAX: selects the maximum value'."\n" - .'* MIN: selects the minimum value'."\n", - 'type' => 'string', - 'example' => 'AVG', - ], - 'Operator' => [ - 'title' => '应用监控/前端监控-判断条件', - 'description' => 'The comparison operator that was used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* CURRENT_GTE: greater than or equal to'."\n" - .'* CURRENT_LTE: less than or equal to'."\n" - .'* PREVIOUS_UP: the increase percentage compared with the last period'."\n" - .'* PREVIOUS_DOWN: the decrease percentage compared with the last period'."\n" - .'* HOH_UP: the increase percentage compared with the last hour'."\n" - .'* HOH_DOWN: the decrease percentage compared with the last hour'."\n" - .'* DOD_UP: the increase percentage compared with the last day'."\n" - .'* DOD_DOWN: the decrease percentage compared with the last day'."\n", - 'type' => 'string', - 'example' => 'CURRENT_GTE', - ], - 'Value' => [ - 'title' => '应用监控/前端监控-阈值', - 'description' => 'The threshold of the alert condition.'."\n", - 'type' => 'string', - 'example' => '1', - ], - ], - ], - ], - ], - ], - 'Filters' => [ - 'title' => '应用监控/前端监控-告警条件-过滤项', - 'description' => 'The filter conditions of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'DimFilters' => [ - 'description' => 'The information about each filter condition of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the filter condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'FilterKey' => [ - 'description' => 'The key of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'rootIp', - ], - 'FilterOpt' => [ - 'description' => 'The logical operator of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'ALL', - ], - 'FilterValues' => [ - 'description' => 'The details of the filter condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the filter condition.'."\n", - 'type' => 'string', - 'example' => '[]', - ], - ], - ], - ], - ], - 'CustomSLSFilters' => [ - 'description' => 'The custom filter condition of the Browser Monitoring alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the custom filter condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'username', - ], - 'Opt' => [ - 'description' => 'The logical operator of the filter condition. Valid values:'."\n" - ."\n" - .'* \\=: equal to'."\n" - .'* not: not equal to'."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Value' => [ - 'description' => 'The value of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'T' => [ - 'description' => 'The log type of Browser Monitoring. This field was not included in other filter conditions.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Show' => [ - 'description' => 'Indicates whether this filter condition was displayed on the frontend.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - ], - ], - ], - 'CustomSLSGroupByDimensions' => [ - 'description' => 'The information of the aggregation dimension.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the aggregation dimension.'."\n", - 'type' => 'string', - 'example' => '["page"]', - ], - ], - 'CustomSLSWheres' => [ - 'description' => 'The details of the custom filter condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the custom filter condition.'."\n", - 'type' => 'string', - 'example' => '["t like \'%api%\'"]', - ], - ], - ], - ], - 'AlertCheckType' => [ - 'title' => 'Prometheus告警-告警检查类型', - 'description' => 'The alert check type of the Prometheus alert rule. Valid values:'."\n" - ."\n" - .'* STATIC: a static threshold value.'."\n" - .'* CUSTOM: a custom PromQL statement.'."\n", - 'type' => 'string', - 'example' => 'STATIC', - ], - 'ClusterId' => [ - 'title' => 'Prometheus告警-集群ID', - 'description' => 'The ID of the monitored cluster.'."\n", - 'type' => 'string', - 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', - ], - 'AlertGroup' => [ - 'title' => 'Prometheus告警-告警分组ID', - 'description' => 'The alert contact group ID of the Prometheus alert rule. Valid values:'."\n" - ."\n" - .'* \\-1: custom PromQL'."\n" - .'* 1: Kubernetes load'."\n" - .'* 15: Kubernetes node'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - ], - 'PromQL' => [ - 'title' => 'Prometheus告警-PromQL语句', - 'description' => 'The PromQL statement of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', - ], - 'Duration' => [ - 'title' => 'Prometheus告警-持续时间', - 'description' => 'The duration of the Prometheus alert rule. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Level' => [ - 'title' => 'Prometheus告警-等级', - 'description' => 'The severity level of the Prometheus alert rule.'."\n" - ."\n" - .'* P1: Alert notifications are sent for major issues that affect the availability of core business, have a huge impact, and may lead to serious consequences.'."\n" - .'* P2: Alert notifications are sent for service errors that affect the system availability with relatively limited impact.'."\n" - .'* P3: Alert notifications are sent for issues that may cause service errors or negative effects, or alert notifications for services that are relatively less important.'."\n" - .'* P4: Alert notifications are sent for low-priority issues that do not affect your business.'."\n" - .'* Default: Alert notifications are sent regardless of alert levels.'."\n", - 'type' => 'string', - 'example' => 'P2', - ], - 'Message' => [ - 'title' => 'Prometheus告警-告警内容', - 'description' => 'The alert message of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'example' => 'Namespace: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / Container: {{$labels.container}} Memory usage exceeds 80%. Current value: {{ printf \\\\\\\\\\"%.2f\\\\\\\\\\" $value }}%'."\n", - ], - 'Labels' => [ - 'title' => 'Prometheus告警-Label', - 'description' => 'The tags of the Prometheus alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '键', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Value' => [ - 'title' => '值', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], - 'Annotations' => [ - 'title' => 'Prometheus告警-Annotation', - 'description' => 'The annotations of the Prometheus alert rule.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''], + 'Contacts' => [ + 'description' => 'The information about the alert contacts.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The annotation struct.'."\n", 'type' => 'object', 'properties' => [ - 'Name' => [ - 'title' => '键', - 'description' => 'The key of the annotation.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Value' => [ - 'title' => '值', - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], + 'UpdateTime' => ['description' => 'The timestamp generated when the alert contact was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1580258717000', 'title' => ''], + 'DingRobot' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', 'title' => ''], + 'Webhook' => ['description' => 'The information about the webhook.'."\n", 'type' => 'string', 'example' => '{\\"body\\":\\"{ \\\\\\"msg_type\\\\\\": \\\\\\"text\\\\\\", \\\\\\"content\\\\\\": { \\\\\\"text\\\\\\": \\\\\\"$content\\\\\\" } }\\",\\"header\\":{\\"Arms-Content-Type\\":\\"json\\"},\\"method\\":\\"post\\",\\"params\\":{},\\"url\\":\\"https://***",\\"userId\\":\\"1131971649***\\"}",', 'title' => ''], + 'Email' => ['description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'example' => 'someone@example.com', 'title' => ''], + 'ContactId' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp generated when the alert contact was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1572349025000', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'ContactName' => ['description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'example' => 'John Doe', 'title' => ''], + 'SystemNoc' => ['description' => 'Indicates whether the alert contact receives system notifications. Valid values:'."\n" + ."\n" + .'* `true`: The alert contact receives system notifications.'."\n" + .'* `false`: The alert contact does not receive system notifications.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Content' => ['description' => 'The contact group to which the contact belongs. If your contacts are added to multiple contact groups, the contact groups are separated by vertical bars (|).'."\n", 'type' => 'string', 'example' => '默认分组|SRE分组', 'title' => ''], + 'Phone' => ['description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'example' => '1381111*****', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], - ], - ], - 'Tags' => [ - 'description' => 'The list of tags.', - 'type' => 'array', - 'items' => [ 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.', - 'type' => 'string', - 'example' => 'owner', - ], - 'Value' => [ - 'description' => 'The tag value.', - 'type' => 'string', - 'example' => 'John', - ], - ], + 'title' => '', + 'example' => '', ], - ], - 'NotifyMode' => [ - 'description' => 'Notification Mode.', - 'type' => 'string', - 'example' => 'NORMAL_MODE', + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"337B8F7E-0A64-5768-9225-E9B3CF******\\",\\n \\"AlertRule\\": {\\n \\"AlertId\\": 5510445,\\n \\"AlertName\\": \\"arms-test\\",\\n \\"UserId\\": \\"1131971649******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AlertType\\": \\"APPLICATION_MONITORING_ALERT_RULE\\",\\n \\"AlertStatus\\": \\"RUNNING\\",\\n \\"CreatedTime\\": 1641438611000,\\n \\"UpdatedTime\\": 1641438611000,\\n \\"Extend\\": \\"{\\\\\\\\\\\\\\"alarmContext\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"报警名称:$报警名称\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n筛选条件: $筛选\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警时间: $报警时间\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警内容: $报警内容\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"subTitle\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alertWays\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[0,1]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"contactGroupIds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"381,5075\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"notice\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeEndTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeStartTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000}\\\\\\\\\\\\\\"}\\",\\n \\"NotifyStrategy\\": \\"ALERT_MANAGER\\",\\n \\"Pids\\": [\\n \\"b590lhguqs@40d8deedfa9******\\"\\n ],\\n \\"AutoAddNewApplication\\": false,\\n \\"MetricsType\\": \\"JVM\\",\\n \\"AlertRuleContent\\": {\\n \\"Condition\\": \\"OR\\",\\n \\"AlertRuleItems\\": [\\n {\\n \\"N\\": 1,\\n \\"MetricKey\\": \\"JVM非堆总使用内存量\\",\\n \\"Aggregate\\": \\"AVG\\",\\n \\"Operator\\": \\"CURRENT_GTE\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"Filters\\": {\\n \\"DimFilters\\": [\\n {\\n \\"FilterKey\\": \\"rootIp\\",\\n \\"FilterOpt\\": \\"ALL\\",\\n \\"FilterValues\\": [\\n \\"[]\\"\\n ]\\n }\\n ],\\n \\"CustomSLSFilters\\": [\\n {\\n \\"Key\\": \\"username\\",\\n \\"Opt\\": \\"=\\",\\n \\"Value\\": \\"test\\",\\n \\"T\\": \\"null\\",\\n \\"Show\\": false\\n }\\n ],\\n \\"CustomSLSGroupByDimensions\\": [\\n \\"[\\\\\\"page\\\\\\"]\\"\\n ],\\n \\"CustomSLSWheres\\": [\\n \\"[\\\\\\"t like \'%api%\'\\\\\\"]\\"\\n ]\\n },\\n \\"AlertCheckType\\": \\"STATIC\\",\\n \\"ClusterId\\": \\"ceba9b9ea5b924dd0b6726d2de6******\\",\\n \\"AlertGroup\\": -1,\\n \\"PromQL\\": \\"node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100\\",\\n \\"Duration\\": \\"1\\",\\n \\"Level\\": \\"P2\\",\\n \\"Message\\": \\"命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"%.2f\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\" $value }}%\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"owner\\",\\n \\"Value\\": \\"John\\"\\n }\\n ],\\n \\"NotifyMode\\": \\"NORMAL_MODE\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateAlertRuleResponse>\\n <RequestId>337B8F7E-0A64-5768-9225-E9B3CF******</RequestId>\\n <AlertRule>\\n <AlertId>5510445</AlertId>\\n <AlertName>arms-test</AlertName>\\n <UserId>1131971649******</UserId>\\n <RegionId>cn-hangzhou</RegionId>\\n <AlertType>APPLICATION_MONITORING_ALERT_RULE</AlertType>\\n <AlertStatus>RUNNING</AlertStatus>\\n <CreatedTime>1641438611000</CreatedTime>\\n <UpdatedTime>1641438611000</UpdatedTime>\\n <Extend>{\\\\\\"alarmContext\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"报警名称:$报警名称\\\\\\\\\\\\\\\\n筛选条件: $筛选\\\\\\\\\\\\\\\\n报警时间: $报警时间\\\\\\\\\\\\\\\\n报警内容: $报警内容\\\\\\\\\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"subTitle\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"\\\\\\\\\\\\\\"}\\\\\\",\\\\\\"alertWays\\\\\\":\\\\\\"[0,1]\\\\\\",\\\\\\"contactGroupIds\\\\\\":\\\\\\"381,5075\\\\\\",\\\\\\"notice\\\\\\":\\\\\\"{\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\"noticeEndTime\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\"noticeStartTime\\\\\\\\\\\\\\":1480521600000,\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\":1480521600000}\\\\\\"}</Extend>\\n <NotifyStrategy>ALERT_MANAGER</NotifyStrategy>\\n <Pids>b590lhguqs@40d8deedfa9******</Pids>\\n <AutoAddNewApplication>false</AutoAddNewApplication>\\n <MetricsType>JVM</MetricsType>\\n <AlertRuleContent>\\n <Condition>\\"|\\"</Condition>\\n <AlertRuleItems>\\n <N>1</N>\\n <MetricKey>JVM非堆总使用内存量</MetricKey>\\n <Aggregate>AVG</Aggregate>\\n <Operator>CURRENT_GTE</Operator>\\n <Value>1</Value>\\n </AlertRuleItems>\\n </AlertRuleContent>\\n <Filters>\\n <DimFilters>\\n <FilterKey>rootIp</FilterKey>\\n <FilterOpt>ALL</FilterOpt>\\n <FilterValues>[]</FilterValues>\\n </DimFilters>\\n <CustomSLSFilters>\\n <Key>username</Key>\\n <Opt>=</Opt>\\n <Value>test</Value>\\n <T>null</T>\\n <Show>false</Show>\\n </CustomSLSFilters>\\n <CustomSLSGroupByDimensions>[\\"page\\"]</CustomSLSGroupByDimensions>\\n <CustomSLSWheres>[\\"t like \'%api%\'\\"]</CustomSLSWheres>\\n </Filters>\\n <AlertCheckType>STATIC</AlertCheckType>\\n <ClusterId>ceba9b9ea5b924dd0b6726d2de6******</ClusterId>\\n <AlertGroup>-1</AlertGroup>\\n <PromQL>node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100</PromQL>\\n <Duration>1</Duration>\\n <Level>P2</Level>\\n <Message>命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\\\\\\\\\"%.2f\\\\\\\\\\\\\\" $value }}%</Message>\\n <Labels>\\n <Name>123</Name>\\n <Value>abc</Value>\\n </Labels>\\n <Annotations>\\n <Name>123</Name>\\n <Value>abc</Value>\\n </Annotations>\\n </AlertRule>\\n</CreateOrUpdateAlertRuleResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateAlertRule', - 'requestParamsDescription' => '### **AlertRuleContent** '."\n" - ."\n" - .'```'."\n" - .'{ '."\n" - .' "Condition": "OR",'."\n" - .' "AlertRuleItems": ['."\n" - .' { "Operator": "CURRENT_LTE",'."\n" - .' "MetricKey": "appstat.jvm.threadcount",'."\n" - .' "Value": 1000,'."\n" - .' "Aggregate": "AVG",'."\n" - .' "N": 10,'."\n" - .' "Tolerability": 169'."\n" - .' } '."\n" - .' ] '."\n" - .' }'."\n" - .'```'."\n" - ."\n" - .'- Condition: Trigger logic between multiple alarm conditions.'."\n" - .' - OR: Satisfy any of the following conditions.'."\n" - .' - AND: Satisfy the following conditions at the same time.'."\n" - .'- Operator: Judgment condition of the alarm condition.'."\n" - .' - CURRENT _ GTE: Greater than or equal to'."\n" - .' - CURRENT _ LTE: Less than or equal to'."\n" - .' - PREVIOUS _ UP: Month-on-month increase percentage'."\n" - .' - PREVIOUS _ DOWN: Month-on-month decrease percentage'."\n" - .' - HOH _ UP: Year-on-year increase percentage compared with the previous hour'."\n" - .' - HOH _ DOWN: Year-on-year decrease percentage compared with the previous hour'."\n" - .' - DOD _ UP: Year-on-year increase percentage compared with yesterday'."\n" - .' - DOD _ DOWN: Year-on-year decrease percentage compared with yesterday'."\n" - .' - INTERVAL _ EXCEED: Interval detection. Note: Interval detection does not support multi-condition triggering.'."\n" - .'- Metric Key: The indicator of the specific alarm condition. Different Metrics Types have different corresponding indicators. Please refer to the following description for the corresponding relationship.'."\n" - .'- Value: Alarm condition threshold.'."\n" - .'- Aggregate: Alarm condition aggregation method.'."\n" - .' - AVG: Average'."\n" - .' - SUM: Sum'."\n" - .' - MAX: Maximum value'."\n" - .' - MIN: Minimum value'."\n" - .' - CONTINUOUS: Continuous'."\n" - .' - AVG _ WEIGHTED: Weighted average of error rate'."\n" - .'- N: The last N minutes.'."\n" - .'- Tolerability: Indicates the interval tolerance, with a value between 1 and 200.', - ], - 'DeleteAlertRule' => [ - 'summary' => 'Deletes an alert rule.', - 'methods' => [ - 'get', - 'post', + 'title' => 'SearchAlertContact', + 'summary' => 'Queries alert contacts.', + 'description' => 'This operation is no longer maintained. To query alert contacts, call the DescribeContacts operation provided by the new version of Alert Management.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-23T04:12:34.000Z', 'description' => 'Response parameters changed, Error codes changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAlertContact'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchAlertContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23,\\n \\"Contacts\\": [\\n {\\n \\"UpdateTime\\": 1580258717000,\\n \\"DingRobot\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f6****\\",\\n \\"Webhook\\": \\"{\\\\\\\\\\\\\\"body\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"msg_type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\", \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"$content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\" } }\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"header\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Arms-Content-Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"json\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"post\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"params\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://***\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1131971649***\\\\\\\\\\\\\\"}\\\\\\",\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"ContactId\\": 123,\\n \\"CreateTime\\": 1572349025000,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"ContactName\\": \\"John Doe\\",\\n \\"SystemNoc\\": false,\\n \\"Content\\": \\"默认分组|SRE分组\\",\\n \\"Phone\\": \\"1381111*****\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'SearchAlertContactGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -37313,541 +26134,326 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - 'riskType' => 'none', - 'chargeType' => 'free', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'AlertId', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'title' => '告警规则ID', - 'description' => 'The alert rule ID.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert rule, see [GetAlertRules](~~2612348~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The name of the alert contact group.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TestGroup', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. Default value: `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'John Doe', 'title' => ''], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert contact. You can call the SearchAlertContact operation to query the contact IDs. For more information, see [SearchAlertContact](~~130703~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '123', 'title' => ''], + ], + [ + 'name' => 'ContactGroupIds', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert contact group. You can query multiple alert contact groups at a time. Separate multiple group IDs with commas (,).'."\n", 'type' => 'string', 'required' => false, 'example' => '746', 'title' => ''], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to return all alert contacts in the queried alert contact group. By default, not all alert contacts are returned.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', 'title' => ''], + 'ContactGroups' => [ + 'description' => 'The information about the alert contact groups.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The time when the alert contact group was last modified. 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' => '1529668855000', 'title' => ''], + 'ContactGroupName' => ['description' => 'The name of the alert contact group.'."\n", 'type' => 'string', 'example' => 'TestGroup', 'title' => ''], + 'ContactGroupId' => ['description' => 'The ID of the alert contact group.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '746', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the alert contact group list was created. 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' => '1529668855000', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'Contacts' => [ + 'description' => 'The alert contact list.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => ['description' => 'The time when the alert contact group was last modified. 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' => '1580258717000', 'title' => ''], + 'DingRobot' => ['description' => 'The webhook URL of the DingTalk chatbot.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', 'title' => ''], + 'Email' => ['description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'example' => 'someone@example.com', 'title' => ''], + 'ContactId' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the alert contact group list was created. 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' => '1572349025000', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'ContactName' => ['description' => 'The name of the alert contact.'."\n", 'type' => 'string', 'example' => 'John Doe', 'title' => ''], + 'SystemNoc' => ['description' => 'Indicates whether the alert contact receives system notifications. Valid values:'."\n" + ."\n" + .'* true: receives system notifications.'."\n" + .'* false: does not receive system notifications.'."\n", 'type' => 'boolean', 'example' => 'false', 'title' => ''], + 'Phone' => ['description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'example' => '1381111*****', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertRuleResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteAlertRuleResponse>","errorExample":""}]', - 'title' => 'DeleteAlertRule', - ], - 'ListAlertEvents' => [ - 'summary' => 'Queries historical alert events.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"ContactGroups\\": [\\n {\\n \\"UpdateTime\\": 1529668855000,\\n \\"ContactGroupName\\": \\"TestGroup\\",\\n \\"ContactGroupId\\": 746,\\n \\"CreateTime\\": 1529668855000,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"Contacts\\": [\\n {\\n \\"UpdateTime\\": 1580258717000,\\n \\"DingRobot\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f6****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"ContactId\\": 123,\\n \\"CreateTime\\": 1572349025000,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"ContactName\\": \\"John Doe\\",\\n \\"SystemNoc\\": false,\\n \\"Phone\\": \\"1381111*****\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchAlertContactGroupResponse>\\n<ContactGroups>\\n <ContactGroupId>746</ContactGroupId>\\n <UpdateTime>1529668855000</UpdateTime>\\n <ContactGroupName>TestGroup</ContactGroupName>\\n <UserId>113197164949****</UserId>\\n <CreateTime>1529668855000</CreateTime>\\n</ContactGroups>\\n<ContactGroups>\\n <Contacts>\\n <Email>someone@example.com</Email>\\n <UserId>113197164949****</UserId>\\n <Phone>1381111*****</Phone>\\n <CreateTime>1572349025000</CreateTime>\\n <UpdateTime>1580258717000</UpdateTime>\\n <ContactId>123</ContactId>\\n <DingRobot>https://oapi.dingtalk.com/robot/send?access_token=91f2f6****</DingRobot>\\n <SystemNoc>false</SystemNoc>\\n <ContactName>John Doe</ContactName>\\n </Contacts>\\n</ContactGroups>\\n<RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>\\n</SearchAlertContactGroupResponse>","errorExample":""}]', + 'title' => 'SearchAlertContactGroup', + 'summary' => 'Queries alert contact groups.', + 'description' => 'The operation is no longer maintained. Call the DescribeContactGroups operation in the alert management module to query alert contact groups.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T06:25:27.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAlertContactGroup'], + ], ], + 'ramActions' => [], + ], + 'SearchAlertHistories' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '44501', + 'abilityTreeNodes' => ['FEATUREarmsEYPVV6'], ], 'parameters' => [ [ - 'name' => 'AlertName', + 'name' => 'AlertId', 'in' => 'query', - 'schema' => [ - 'title' => '告警名称', - 'description' => 'The name of the alert.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test-triggered alert'."\n", - ], + 'schema' => ['description' => 'The ID of the alert rule. You can call the SearchAlertRules operation and view the `Id` parameter in the response. For more information, see [SearchAlertRules](~~175825~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'StartTime', + 'name' => 'AlertType', 'in' => 'query', - 'schema' => [ - 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', - 'description' => 'The start time of the alert events that you want to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-19 00:00:00', - ], + 'schema' => ['description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'* `1`: a custom alert rule that is used to monitor drill-down data sets'."\n" + .'* `3`: a custom alert rule that is used to monitor tiled data sets'."\n" + .'* `4`: an alert rule that is used to monitor web pages, including the default alert rule for browser monitoring'."\n" + .'* `5`: an alert rule that is used to monitor applications, including the default alert rule for application monitoring'."\n" + .'* `6`: the default alert rule for browser monitoring'."\n" + .'* `7`: the default alert rule for application monitoring'."\n" + .'* `8`: a Tracing Analysis alert rule'."\n" + .'* `101`: a Prometheus alert rule'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '4', 'title' => ''], ], [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', - 'description' => 'The end time of the alert events that you want to query. Specify the time in the YYYY-MM-DD HH:mm:ss format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-22 23:59:59', - ], - ], - [ - 'name' => 'Page', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Default value: `1`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: `10`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'MatchingConditions', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '事件匹配规则列表', - 'description' => 'The list of matching conditions.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[ { "value": "ARMS_NOTIFICATION", "key": "clustername", "operator": "eq" } ] },{ "matchingConditions": [ { "value": "test", "key": "alertname", "operator": "eq" } ]', - ], + 'schema' => ['description' => 'The ID of the region. Default value: `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Status', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'description' => 'The status of the alert events. Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Silenced'."\n" - .'* Resolved'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Active', - ], + 'schema' => ['description' => 'The beginning of the time range to query. The value is a UNIX timestamp of the LONG data type. Unit: milliseconds. The default value is 10 minutes before the current time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1595568910000', 'title' => ''], ], [ - 'name' => 'ShowNotificationPolicies', + 'name' => 'EndTime', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to show the associated notification policy.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], + 'schema' => ['description' => 'The end of the time range to query. The value is a UNIX timestamp of the LONG data type. Unit: milliseconds. The default value is the current time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1579499626000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', 'title' => ''], 'PageBean' => [ - 'title' => '返回结构体', 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The number of the page returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'Events' => [ - 'title' => '告警事件历史信息组', - 'description' => 'The queried historical alert events.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'AlarmHistories' => [ + 'description' => 'The information about alert records.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The alert events.'."\n", 'type' => 'object', 'properties' => [ - 'AlertName' => [ - 'title' => '告警名称', - 'description' => 'The name of the alert.'."\n", - 'type' => 'string', - 'example' => 'Test-triggered alert'."\n", - ], - 'Severity' => [ - 'title' => '告警等级(critical - p1 , error - p2, warning - p3, page - p4, default - p6)', - 'description' => 'The severity level of the alert. Valid values:'."\n" - ."\n" - .'* critical: P1'."\n" - .'* error: P2'."\n" - .'* warning: P3'."\n" - .'* page: P4'."\n" - .'* default: P6'."\n", - 'type' => 'string', - 'example' => 'critical', - ], - 'Status' => [ - 'title' => '告警状态(Active - 正在发生, Silenced - 被静默, Resolved - 已恢复 )', - 'description' => 'The status of the alert event. Valid values:'."\n" - ."\n" - .'* Active'."\n" - .'* Silenced'."\n" - .'* Resolved'."\n", - 'type' => 'string', - 'example' => 'Active', - ], - 'StartTime' => [ - 'title' => '开始时间', - 'description' => 'The start time.'."\n", - 'type' => 'string', - 'example' => '2021-12-20 17:42:16', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'description' => 'The end time.'."\n", - 'type' => 'string', - 'example' => '2021-12-20 17:42:16', - ], - 'ReceiveTime' => [ - 'title' => '事件接受时间', - 'description' => 'The time when the alert event was received.'."\n", - 'type' => 'string', - 'example' => '2021-12-20 17:42:16', - ], - 'IntegrationName' => [ - 'title' => '集成名称', - 'description' => 'The name of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'Custom integration'."\n", - ], - 'IntegrationType' => [ - 'title' => '集成类型', - 'description' => 'The type of the alert integration.'."\n", - 'type' => 'string', - 'example' => 'CUSTOM', - ], - 'GeneratorURL' => [ - 'title' => '事件地址', - 'description' => 'The URL of the alert event.'."\n", - 'type' => 'string', - 'example' => 'https://xxx.xx/', - ], - 'Description' => [ - 'title' => '事件描述', - 'description' => 'The description of the alert event.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'Annotations' => [ - 'title' => '注释列表', - 'description' => 'The annotations.'."\n", - 'type' => 'string', - 'example' => '[{\\"Name\\":\\"annotation-a\\",\\"Value\\":\\"annotation a value\\"}]', - ], - 'Labels' => [ - 'title' => '标签列表', - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => '[{\\"name\\":\\"severity\\",\\"value\\":\\"error\\"}]', - ], - 'Alarms' => [ - 'title' => '关联告警', - 'description' => 'The associated alerts.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the alert.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlarmId' => [ - 'title' => '告警ID', - 'description' => 'The ID of the alert.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '77444', - ], - 'AlarmName' => [ - 'title' => '告警名称', - 'description' => 'The name of the alert.'."\n", - 'type' => 'string', - 'example' => 'Test-triggered alert'."\n", - ], - 'State' => [ - 'title' => '告警状态(0-待处理，1-处理中，2-已解决）', - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is pending.'."\n" - .'* 1: The alert is being handled.'."\n" - .'* 2: The alert is cleared.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'CreateTime' => [ - 'title' => '告警创建时间', - 'description' => 'The time when the alert was created.'."\n", - 'type' => 'string', - 'example' => '2021-12-20 07:10:18', - ], - ], - ], - ], - 'HandlerName' => [ - 'description' => 'The user who handled the alert.'."\n", - 'type' => 'string', - 'example' => 'Tom'."\n", - ], - 'NotificationPolicies' => [ - 'description' => 'The associated notification policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification policies.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '646093', - ], - 'Name' => [ - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'P1 alert notification policy'."\n", - ], - ], - ], - ], - 'TriggerCount' => [ - 'description' => 'The number of times the event is triggered.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], + 'AlarmTime' => ['description' => 'The time when the alert notification was sent.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1595564179000', 'title' => ''], + 'StrategyId' => ['description' => 'The internal fields.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'AlarmResponseCode' => ['description' => 'The response code returned after the alert notification was sent.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Emails' => ['description' => 'The email address of the alert contact.'."\n", 'type' => 'string', 'example' => 'someone@example.com', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'AlarmSources' => ['description' => 'The webhook URL, such as the webhook URL of a DingTalk chatbot.'."\n", 'type' => 'string', 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****', 'title' => ''], + 'AlarmContent' => ['description' => 'The content of the alert notification.'."\n", 'type' => 'string', 'example' => '"报警名称：Alert1\\n报警时间：2020-07-24 12:14:00\\n报警内容：共有4条记录触发异常：****"', 'title' => ''], + 'Phones' => ['description' => 'The mobile phone number of the alert contact.'."\n", 'type' => 'string', 'example' => '1381111****', 'title' => ''], + 'AlarmType' => ['description' => 'The type of the alert rule. Default value: 4. Valid values:'."\n" + ."\n" + .'* `1`: a custom alert rule that is used to monitor drill-down data sets'."\n" + .'* `3`: a custom alert rule that is used to monitor tiled data sets'."\n" + .'* `4`: an alert rule that is used to monitor web pages, including the default alert rule for browser monitoring'."\n" + .'* `5`: an alert rule that is used to monitor applications, including the default alert rule for application monitoring'."\n" + .'* `6`: the default alert rule for browser monitoring'."\n" + .'* `7`: the default alert rule for application monitoring'."\n" + .'* `8`: a Tracing Analysis alert rule'."\n" + .'* `101`: a Prometheus alert rule'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'Target' => ['description' => 'The internal fields.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'Id' => ['description' => 'The ID of the alert notification.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 24,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"Events\\": [\\n {\\n \\"AlertName\\": \\"测试触发的告警\\",\\n \\"Severity\\": \\"critical\\",\\n \\"Status\\": \\"Active\\",\\n \\"StartTime\\": \\"2021-12-20 17:42:16\\",\\n \\"EndTime\\": \\"2021-12-20 17:42:16\\",\\n \\"ReceiveTime\\": \\"2021-12-20 17:42:16\\",\\n \\"IntegrationName\\": \\"自定义集成\\",\\n \\"IntegrationType\\": \\"CUSTOM\\",\\n \\"GeneratorURL\\": \\"https://xxx.xx/\\",\\n \\"Description\\": \\"测试\\",\\n \\"Annotations\\": \\"[{\\\\\\\\\\\\\\"Name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"annotation-a\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"Value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"annotation a value\\\\\\\\\\\\\\"}]\\",\\n \\"Labels\\": \\"[{\\\\\\\\\\\\\\"name\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"severity\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"error\\\\\\\\\\\\\\"}]\\",\\n \\"Alarms\\": [\\n {\\n \\"AlarmId\\": 77444,\\n \\"AlarmName\\": \\"测试触发的告警\\",\\n \\"State\\": 0,\\n \\"CreateTime\\": \\"2021-12-20 07:10:18\\"\\n }\\n ],\\n \\"HandlerName\\": \\"张三\\",\\n \\"NotificationPolicies\\": [\\n {\\n \\"Id\\": 646093,\\n \\"Name\\": \\"P1告警通知策略\\"\\n }\\n ],\\n \\"TriggerCount\\": 10\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'ListAlertEvents', - ], - 'GetAlertRules' => [ - 'summary' => 'Queries alert rules.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AlarmHistories\\": [\\n {\\n \\"AlarmTime\\": 1595564179000,\\n \\"StrategyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AlarmResponseCode\\": 200,\\n \\"Emails\\": \\"someone@example.com\\",\\n \\"UserId\\": \\"113197164949****\\",\\n \\"AlarmSources\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****\\",\\n \\"AlarmContent\\": \\"\\\\\\"报警名称：Alert1\\\\\\\\n报警时间：2020-07-24 12:14:00\\\\\\\\n报警内容：共有4条记录触发异常：****\\\\\\"\\",\\n \\"Phones\\": \\"1381111****\\",\\n \\"AlarmType\\": 4,\\n \\"Target\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Id\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'SearchAlertHistories', + 'summary' => 'Queries the alert records of an alert rule.', + 'description' => 'This operation is no longer maintained. To query alert records, call the ListAlerts operation provided by the new version of Alert Management.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-21T08:17:47.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'SearchAlertRules' => [ + 'summary' => 'Queries alert rules.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - 'abilityTreeCode' => '109306', - 'abilityTreeNodes' => [ - 'FEATUREarms20UGKV', - ], + 'operationType' => 'none', + 'abilityTreeCode' => '44502', + 'abilityTreeNodes' => ['FEATUREarms20UGKV'], ], 'parameters' => [ [ - 'name' => 'AlertIds', + 'name' => 'Title', 'in' => 'query', - 'schema' => [ - 'title' => '告警规则ID', - 'description' => 'The unique IDs of alert rules.'."\n" - ."\n" - .'* If you do not specify this parameter, the API operation does not filter alert rules based on their IDs.'."\n" - .'* If you specify this parameter, the API operation returns only the information of the specified alert rules. Other filter conditions also take effect.'."\n" - ."\n" - .'> When you call the GetAlertRules operation, you can specify other request parameters to obtain the AlertIds parameter from the response. Then, you can specify the AlertIds parameter to query the specified alert rules.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["12345"]', - ], + 'schema' => ['description' => 'The alert rule name.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'AlertRuleTitle', 'title' => ''], ], [ - 'name' => 'AlertNames', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'title' => '告警规则名称', - 'description' => 'The names of alert rules. When you create alert rules of the new version, you cannot specify duplicate names. However, existing alert rules may have duplicate names. Therefore, the **AlertName** parameter does not uniquely identify an alert rule.'."\n" - ."\n" - .'* If you do not specify this parameter, the API operation does not filter alert rules based on their names.'."\n" - .'* If you specify this parameter, the API operation returns only the information of the specified alert rules. Other filter conditions also take effect.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '["test"]', - ], + 'schema' => ['description' => 'The alert rule type. Valid values:'."\n" + ."\n" + .'* `1`: custom alert rules that are used to monitor drill-down data sets'."\n" + .'* `3`: custom alert rules that are used to monitor tiled data sets'."\n" + .'* `4`: alert rules that are used to monitor the browser, including the default frontend alert rules'."\n" + .'* `5`: alert rules that are used to monitor applications, including the default application alert rules'."\n" + .'* `6`: the default browser alert rules'."\n" + .'* `7`: the default application alert rules'."\n" + .'* `8`: Tracing Analysis alert rules'."\n" + .'* `101`: Prometheus alert rules'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '4', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'CurrentPage', 'in' => 'query', - 'schema' => [ - 'title' => '地域', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The page number of the page to return. Default value: `1`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'AlertType', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'title' => '告警规则类型（必填）', - 'description' => 'The type of the alert rule. This parameter is required for the new version of Alert Management. Valid values:'."\n" - ."\n" - .'* APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring'."\n" - .'* BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring'."\n" - .'* PROMETHEUS_MONITORING_ALERT_RULE: alert rule for Managed Service for Prometheus'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'APPLICATION_MONITORING_ALERT_RULE', - 'enum' => [ - 'BROWSER_MONITORING_ALERT_RULE', - 'APPLICATION_MONITORING_ALERT_RULE', - 'PROMETHEUS_MONITORING_ALERT_RULE', - 'browser monitoring alert', - 'application monitoring alert', - 'prometheus monitoring alert', - ], - ], + 'schema' => ['description' => 'The number of entries to return per page. Default value: `10`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '20', 'title' => ''], ], [ - 'name' => 'AlertStatus', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '告警规则运行状态', - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* STOPPED'."\n" - .'* PAUSED'."\n" - ."\n" - .'> The PAUSED state indicates an abnormal and paused alert rule. This may result from excessively large threshold values or deleted associated clusters.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'RUNNING', - 'enum' => [ - 'STOPPED', - 'RUNNING', - 'PAUSED', - ], - ], + 'schema' => ['description' => 'The region ID of the alert data. For more information about the mappings between **RegionId** and **SystemRegionId**, see the detailed description below the table.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ClusterId', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the monitored cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ceba9b9ea5b924dd0b6726d2de6******'."\n", - ], + 'schema' => ['description' => 'The process identifier (PID) of the application that is associated with the alert rule. For more information about how to obtain the PID, see [Obtain the PID of an application](https://help.aliyun.com/document_detail/186100.html?spm=a2c4g.11186623.6.792.1b50654cqcDPyk#title-imy-7gj-qhr).'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'ProductCode', + 'name' => 'AppType', 'in' => 'query', - 'schema' => [ - 'description' => 'You do not need to configure this parameter.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'null', - ], + 'schema' => ['description' => 'The type of the application that is associated with the alert rule. Valid values:'."\n" + ."\n" + .'* `TRACE`: application'."\n" + .'* `RETCODE`: browser'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TRACE', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'SystemRegionId', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The region ID of the alert rule. For more information about the mappings between **RegionId** and **SystemRegionId**, see the detailed description below the table.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '每一页大小', - 'description' => 'The number of alert rules to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], + ], + [ + 'name' => 'AlertRuleId', + 'in' => 'query', + 'schema' => ['description' => 'The id of AlertRule.', 'type' => 'string', 'required' => false, 'example' => '12345', 'title' => ''], ], [ 'name' => 'Tags', @@ -37857,629 +26463,371 @@ 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ + 'description' => 'The tags.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'type', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prod', - ], + 'Key' => ['description' => 'The key of the tag. The following system preset fields are provided:'."\n" + ."\n" + .'* traceId: the ID of the trace.'."\n" + .'* serverApp: the name of the server application.'."\n" + .'* clientApp: the name of the client application.'."\n" + .'* service: the name of the operation.'."\n" + .'* rpc: the type of the call.'."\n" + .'* msOfSpan: the duration exceeds a specific value.'."\n" + .'* clientIp: the IP address of the client.'."\n" + .'* serverIp: the IP address of the server.'."\n" + .'* isError: specifies whether the call is abnormal.'."\n" + .'* hasTprof: contains only thread profiling.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 1, - ], - ], - [ - 'name' => 'BizRegionId', - 'in' => 'query', - 'schema' => [ - 'type' => 'string', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', - ], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', 'title' => ''], 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The returned pages.'."\n", + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of queried alert rules.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The number of pages returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每一页大小', - 'description' => 'The number of alert rules returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '20', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '23', 'title' => ''], 'AlertRules' => [ - 'title' => '告警规则列表', - 'description' => 'The alert rules.'."\n", + 'description' => 'The details of the alert rules.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The details of each alert rule.'."\n", 'type' => 'object', 'properties' => [ - 'AlertId' => [ - 'description' => 'The alert rule ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5730***', - ], - 'AlertName' => [ - 'title' => '告警规则名称', - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'arms-test', - ], - 'UserId' => [ - 'title' => '用户UID', - 'description' => 'The ID of the Alibaba Cloud account.'."\n", - 'type' => 'string', - 'example' => '1131971649******', - ], - 'RegionId' => [ - 'title' => '地域', - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AlertType' => [ - 'title' => '告警规则类型', - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'* APPLICATION_MONITORING_ALERT_RULE: alert rule for Application Monitoring'."\n" - .'* BROWSER_MONITORING_ALERT_RULE: alert rule for Browser Monitoring'."\n" - .'* PROMETHEUS_MONITORING_ALERT_RULE: Prometheus alert rule'."\n", - 'type' => 'string', - 'example' => 'APPLICATION_MONITORING_ALERT_RULE', - ], - 'AlertStatus' => [ - 'title' => '告警规则状态', - 'description' => 'The status of the alert rule. Valid values:'."\n" - ."\n" - .'* RUNNING'."\n" - .'* STOPPED'."\n" - .'* PAUSED'."\n" - ."\n" - .'> The PAUSED state indicates that the alert rule is abnormal and has been suspended. This may be because the specified threshold value is excessively large, or the associated cluster has been deleted.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'CreatedTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the alert rule was created. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640333981000', - ], - 'UpdatedTime' => [ - 'title' => '更新时间', - 'description' => 'The time when the alert rule was updated. The value is a timestamp. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1640333981000', - ], - 'Extend' => [ - 'title' => '扩展字段', - 'description' => 'The extended fields.'."\n" - ."\n" - .'> For existing Application Monitoring alert rules, the fields contain information such as contacts, alert template, and notification content.'."\n", - 'type' => 'string', - 'example' => '{\\\\"alarmContext\\\\":\\\\"{\\\\\\\\\\"content\\\\\\\\\\":\\\\\\\\Alert name: $Alert name\\\\\\\\\\\\nFilter condition: $Filter condition\\\\\\\\\\\\nAlert time: $Alert time\\\\\\\\\\\\nAlert content: $Alert content\\\\\\\\\\\\nNote: The alert persists before you receive an email that reminds you to clear the alert. You will be reminded of the alert again 24 hours later. \\\\\\\\\\",\\\\\\\\\\"subTitle\\\\\\\\\\":\\\\\\\\\\"\\\\\\\\\\"}\\\\",\\\\"alertWays\\\\":\\\\"\\[0,1]\\\\",\\\\"contactGroupIds\\\\":\\\\"381,5075\\\\",\\\\"notice\\\\":\\\\"{\\\\\\\\\\"endTime\\\\\\\\\\":1480607940000,\\\\\\\\\\"noticeEndTime\\\\\\\\\\":1480607940000,\\\\\\\\\\"noticeStartTime\\\\\\\\\\":1480521600000,\\\\\\\\\\"startTime\\\\\\\\\\":1480521600000}\\\\"}'."\n", - ], - 'NotifyStrategy' => [ - 'title' => '通知策略ID', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'ALERT_MANAGER', - ], - 'Pids' => [ - 'title' => '应用监控/前端监控-告警关联应用ID', - 'description' => 'The process ID (PID) of the application to which the Application Monitoring or Browser Monitoring alert rule is applied.'."\n", + 'Status' => ['description' => 'The status of the alert rule. `RUNNING`: The alert rule is enabled. `STOPPED`: The alert rule is disabled.'."\n", 'type' => 'string', 'example' => 'RUNNING', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp that shows when the alert rule was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1480521600000', 'title' => ''], + 'ContactGroupIdList' => ['description' => 'The ID of the contact group. Multiple IDs are separated by commas (,).'."\n", 'type' => 'string', 'example' => '381*,572*', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp that shows when the alert rule was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1579508519683', 'title' => ''], + 'AlertTitle' => ['description' => 'The name of the alert rule.'."\n", 'type' => 'string', 'example' => 'TestAlertRule', 'title' => ''], + 'UserId' => ['description' => 'The ID of the user to which the alert rule belongs.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'AlertVersion' => ['description' => 'The version of the alert rule. Default value: `1`.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'HostByAlertManager' => ['description' => 'Indicates whether the alert is sent through the alert center. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'AlertType' => ['description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'* `1`: custom alert rules that are used to monitor drill-down data sets'."\n" + .'* `3`: custom alert rules that are used to monitor tiled data sets'."\n" + .'* `4`: alert rules that are used to monitor the browser, including the default frontend alert rules'."\n" + .'* `5`: alert rules that are used to monitor applications, including the default application alert rules'."\n" + .'* `6`: the default browser alert rules'."\n" + .'* `7`: the default application alert rules'."\n" + .'* `8`: Tracing Analysis alert rules'."\n" + .'* `101`: Prometheus alert rules'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'ContactGroupIds' => ['description' => 'The IDs of the alert contact groups. The value is a JSON array.'."\n", 'type' => 'string', 'example' => '[123, 234]', 'title' => ''], + 'Config' => ['description' => 'The configuration items of the alert rule. The value is a JSON string.'."\n" + ."\n" + .'The configuration item **continuous** indicates whether alert notifications are continuously sent. Valid values:'."\n" + ."\n" + .'* `true`: Alert notifications are sent every minute.'."\n" + .'* `false`: The alert silence feature is enabled.'."\n" + ."\n" + .'The configuration item **dataRevision** indicates the data revision policy that is used if no data is obtained or the data is null. Default value: 2. Valid values:'."\n" + ."\n" + .'* `0`: overwrites the data by using the value 0'."\n" + .'* `1`: overwrites the data by using the value 1'."\n" + .'* `2`: overwrites the data by using the value null. This value indicates that no alert is triggered if no data exists'."\n", 'type' => 'string', 'example' => '{\\"continuous\\":true,\\"dataRevision\\":2}', 'title' => ''], + 'RegionId' => ['description' => 'The ID of the region to which the alert rule belongs.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'AlertLevel' => ['description' => 'The severity of the alerts. Only the value `WARN` is supported.'."\n", 'type' => 'string', 'example' => 'WARN', 'title' => ''], + 'TaskStatus' => ['description' => 'The status of the task. This parameter is hidden from users.'."\n", 'type' => 'string', 'example' => '""', 'title' => ''], + 'Title' => ['description' => 'The name of the alert.'."\n", 'type' => 'string', 'example' => 'AlertTest', 'title' => ''], + 'TaskId' => ['description' => 'The ID of the Application Real-Time Monitoring Service (ARMS) task that is associated with the alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Id' => ['description' => 'The ID of the alert rule.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'AlertWays' => [ + 'description' => 'Sending method of alarm notification.', 'type' => 'array', - 'items' => [ - 'description' => 'The PID of the application.'."\n", - 'type' => 'string', - 'example' => '["b590lhguqs@40d8deedfa9******"]', - ], - ], - 'AutoAddNewApplication' => [ - 'title' => '应用监控/前端监控-是否开启新创建应用追加到此告警规则', - 'description' => 'Indicates whether the alert rule is applied to new applications that are created in Application Monitoring or Browser Monitoring. Valid values:'."\n" + 'items' => ['description' => 'The notification method of the alerts. Valid values:'."\n" ."\n" - .'* `true`: yes'."\n" - .'* `false`: no'."\n", - 'type' => 'boolean', - 'example' => 'false', + .'* `SMS`: text message'."\n" + .'* `MAIL`: email'."\n" + .'* `DING_ROBOT`: DingTalk chatbot'."\n", 'type' => 'string', 'example' => '["MAIL", "SMS", "DING_ROBOT"]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'MetricsType' => [ - 'title' => '应用监控/前端监控-告警指标类型', - 'description' => 'The metric type of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'string', - 'example' => 'JVM', + 'AlarmContext' => [ + 'description' => 'The format of the alert notification.'."\n", + 'type' => 'object', + 'properties' => [ + 'AlarmContentTemplate' => ['description' => 'The template of the alert notification.'."\n", 'type' => 'string', 'example' => '报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！', 'title' => ''], + 'SubTitle' => ['description' => 'The sub-title of the alert notification.'."\n", 'type' => 'string', 'example' => 'test', 'title' => ''], + 'AlarmContentSubTitle' => ['description' => 'The sub-title of the alert notification content.'."\n", 'type' => 'string', 'example' => 'TestSubTitle', 'title' => ''], + 'Content' => ['description' => 'The content of the alert notification.'."\n", 'type' => 'string', 'example' => '报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], - 'AlertRuleContent' => [ - 'title' => '应用监控/前端监控-告警规则内容', - 'description' => 'The content of the Application Monitoring or Browser Monitoring alert rule.'."\n", + 'AlertRule' => [ + 'description' => 'The conditions of the alert rule. Multiple conditions are separated by the AND or OR logical operators.'."\n", 'type' => 'object', 'properties' => [ - 'Condition' => [ - 'title' => '应用监控/前端监控-多个告警条件触发逻辑', - 'description' => 'The relationship between multiple alert conditions specified for the Application Monitoring or Browser Monitoring alert rule. Valid values:'."\n" - ."\n" - .'* OR: The alert rule is triggered if one of the conditions is met.'."\n" - .'* AND: The alert rule is triggered if all the conditions are met.'."\n", - 'type' => 'string', - 'example' => 'OR', - ], - 'AlertRuleItems' => [ - 'title' => '应用监控/前端监控-告警条件', - 'description' => 'The trigger conditions of the Application Monitoring or Browser Monitoring alert rule.'."\n", + 'Operator' => ['description' => 'The logical operator between conditions. Valid values: `&`: AND. `|`: OR.'."\n", 'type' => 'string', 'example' => '|', 'title' => ''], + 'Rules' => [ + 'description' => 'The condition of the alert rule.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The details of the alert condition.'."\n", 'type' => 'object', 'properties' => [ - 'N' => [ - 'description' => 'The last N minutes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - 'title' => '', - ], - 'MetricKey' => [ - 'title' => '应用监控/前端监控-具体告警条件的指标', - 'description' => 'The metric of the alert condition.'."\n", - 'type' => 'string', - 'example' => 'appstat.jvm.non_heap_used', - ], - 'Aggregate' => [ - 'title' => '应用监控/前端监控-聚合方式', - 'description' => 'The aggregation method of the alert condition. Valid values:'."\n" - ."\n" - .'* AVG: calculates the average value'."\n" - .'* SUM: calculates the total value'."\n" - .'* MAX: selects the maximum value'."\n" - .'* MIN: selects the minimum value'."\n", - 'type' => 'string', - 'example' => 'AVG', - ], - 'Operator' => [ - 'title' => '应用监控/前端监控-判断条件', - 'description' => 'The operator that is used to compare the metric value with the threshold. Valid values:'."\n" - ."\n" - .'* CURRENT_GTE: greater than or equal to'."\n" - .'* CURRENT_LTE: less than or equal to'."\n" - .'* PREVIOUS_UP: increase in percentage compared with the previous period'."\n" - .'* PREVIOUS_DOWN: decrease in percentage compared with the previous period'."\n" - .'* HOH_UP: increase in percentage compared with the same period in the previous hour'."\n" - .'* HOH_DOWN: decrease in percentage compared with the same period in the previous hour'."\n" - .'* DOD_UP: increase in percentage compared with the same period in the previous day'."\n" - .'* DOD_DOWN: decrease in percentage compared with the same period in the previous day'."\n", - 'type' => 'string', - 'example' => 'CURRENT_GTE', - ], - 'Value' => [ - 'title' => '应用监控/前端监控-阈值', - 'description' => 'The threshold of the alert condition.'."\n", - 'type' => 'string', - 'example' => '1', - ], + 'Measure' => ['description' => 'The metric based on which alerts are triggered. For more information, see the "[Alert metrics](https://help.aliyun.com/document_detail/175825.html#h2-url-4)" section in this topic.'."\n", 'type' => 'string', 'example' => 'appstat.jvm.SystemDiskFree', 'title' => ''], + 'Value' => ['description' => 'The threshold of the condition.'."\n", 'type' => 'number', 'format' => 'float', 'example' => '30', 'title' => ''], + 'Aggregates' => ['description' => 'The aggregation logic of the metric data of the alert rule. Valid values:'."\n" + ."\n" + .'* `AVG`: calculates the average value for each minute'."\n" + .'* `SUM`: calculates the total value for each minute'."\n" + .'* `MAX`: calculates the maximum value for each minute'."\n" + .'* `MIN`: calculates the minimum value for each minute'."\n", 'type' => 'string', 'example' => 'AVG', 'title' => ''], + 'NValue' => ['description' => 'The time range when data is requested. Unit: minutes. For example, a value of 5 indicates that the alert rule applies to the data in the last 5 minutes.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Operator' => ['description' => 'The operation logic of the condition. Valid values:'."\n" + ."\n" + .'* CURRENT_GTE: greater than or equal to'."\n" + .'* CURRENT_LTE: less than or equal to'."\n" + .'* PREVIOUS_UP: the increase percentage compared with the last period'."\n" + .'* PREVIOUS_DOWN: the decrease percentage compared with the last period'."\n" + .'* HOH_UP: the increase percentage compared with the last hour'."\n" + .'* HOH_DOWN: the decrease percentage compared with the last hour'."\n" + .'* DOD_UP: the increase percentage compared with the last day'."\n" + .'* DOD_DOWN: the decrease percentage compared with the last day'."\n", 'type' => 'string', 'example' => 'CURRENT_GTE', 'title' => ''], + 'Alias' => ['description' => 'The displayed description of the alert metric.'."\n", 'type' => 'string', 'example' => '调用响应时间_ms', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Filters' => [ - 'title' => '应用监控/前端监控-告警条件-过滤项', - 'description' => 'The filter conditions of the Application Monitoring or Browser Monitoring alert rule.'."\n", + 'MetricParam' => [ + 'description' => 'The information about the application that is associated with the alert rule.'."\n", 'type' => 'object', 'properties' => [ - 'DimFilters' => [ - 'description' => 'The information about each filter condition of the Application Monitoring or Browser Monitoring alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the filter condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'FilterKey' => [ - 'description' => 'The key of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'rootIp', - ], - 'FilterOpt' => [ - 'description' => 'The logical operator of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'ALL', - ], - 'FilterValues' => [ - 'description' => 'The details of the filter condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The parameters of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - ], - ], - ], - ], - 'CustomSLSFilters' => [ - 'description' => 'The custom filter condition of the Browser Monitoring alert rule.'."\n", + 'Type' => ['description' => 'The type of the metric. Valid values:'."\n" + ."\n" + .'* `txn`: the number of API calls during application monitoring'."\n" + .'* `txn_type`: the types of API calls during application monitoring'."\n" + .'* `db`: database metrics'."\n" + .'* `jvm`: Java virtual machine (JVM) metrics'."\n" + .'* `host`: host metrics'."\n" + .'* `exception`: API call errors'."\n", 'type' => 'string', 'example' => 'DB', 'title' => ''], + 'AppGroupId' => ['description' => 'The ID of the application group that is associated with the alert rule. This parameter is applicable to Enterprise Distributed Application Service (EDAS) applications.'."\n", 'type' => 'string', 'example' => 'DEFAULT', 'title' => ''], + 'AppId' => ['description' => 'The auto-increment ID of the ARMS application. You can ignore this ID.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'Pid' => ['description' => 'The PID of the application that is associated with the alert rule.'."\n", 'type' => 'string', 'example' => '9870ca99-8105-4da7-a3a4-d72dd1b1****', 'title' => ''], + 'Dimensions' => [ + 'description' => 'The dimensions in the condition.'."\n", 'type' => 'array', 'items' => [ - 'description' => 'The details of the custom filter condition.'."\n", 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The key of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'username', - ], - 'Opt' => [ - 'description' => 'The logical operator of the filter condition. Valid values:'."\n" - ."\n" - .'* \\=: equal to'."\n" - .'* not: not equal to'."\n", - 'type' => 'string', - 'example' => '=', - ], - 'Value' => [ - 'description' => 'The value of the filter condition.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'T' => [ - 'description' => 'The log type of Browser Monitoring. This field is not included in other filter conditions.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Show' => [ - 'description' => 'Indicates whether this filter condition is displayed on the frontend.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], + 'Key' => ['description' => 'The key of the dimension. Valid values:'."\n" + ."\n" + .'* `rpc`: the name of the API'."\n" + .'* `rpcType`: the type of the API call, such as HTTP or DUBBO'."\n" + .'* `endpoint`: the name of the database'."\n" + .'* `rootIp`: the IP address of the host'."\n", 'type' => 'string', 'example' => 'rootIp', 'title' => ''], + 'Type' => ['description' => 'The type of the dimension. Valid values:'."\n" + ."\n" + .'* `STATIC`: checks only the value of this dimension. In this case, you must set the **dimensions.value** parameter.'."\n" + .'* `ALL`: checks the values of all dimensions. The metrics of all API calls are checked. If an API call triggers an alert, the name of the API is displayed in the alert notification. In this case, you do not need to set the **dimensions.value** parameter.'."\n" + .'* `DISABLE`: aggregates the values of all dimensions. In this case, you do not need to set the **dimensions.value** parameter.'."\n", 'type' => 'string', 'example' => 'DISABLE', 'title' => ''], + 'Value' => ['description' => 'The value of the dimension.'."\n", 'type' => 'string', 'example' => '"127.0.0.1"', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], - ], - 'CustomSLSGroupByDimensions' => [ - 'description' => 'The information about the aggregation dimension.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the aggregation dimension.'."\n", - 'type' => 'string', - 'example' => '["page"]', - ], - ], - 'CustomSLSWheres' => [ - 'description' => 'The details of the custom filter condition.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The value of the custom filter condition.'."\n", - 'type' => 'string', - 'example' => '["t like \'%api%\'"]', - ], - ], - ], - ], - 'AlertCheckType' => [ - 'title' => 'Prometheus告警-告警检查类型', - 'description' => 'The alert check type of the Prometheus alert rule.'."\n" - ."\n" - .'* STATIC: static threshold'."\n" - .'* CUSTOM: custom PromQL'."\n", - 'type' => 'string', - 'example' => 'STATIC', - ], - 'ClusterId' => [ - 'title' => 'Prometheus告警-集群ID', - 'description' => 'The cluster ID of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', - ], - 'AlertGroup' => [ - 'title' => 'Prometheus告警-告警分组ID', - 'description' => 'The alert contact group ID of the Prometheus alert rule.'."\n" - ."\n" - .'* \\-1: custom PromQL'."\n" - .'* 1: Kubernetes load'."\n" - .'* 15: Kubernetes node'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'PromQL' => [ - 'title' => 'Prometheus告警-PromQL语句', - 'description' => 'The PromQL statement of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', - ], - 'Duration' => [ - 'title' => 'Prometheus告警-持续时间', - 'description' => 'The duration of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'Level' => [ - 'title' => 'Prometheus告警-等级', - 'description' => 'The severity level of the Prometheus alert rule.'."\n" - ."\n" - .'* P1: Alert notifications are sent for major issues that affect the availability of core business, have a huge impact, and may lead to serious consequences.'."\n" - .'* P2: Alert notifications are sent for service errors that affect the system availability with relatively limited impact.'."\n" - .'* P3: Alert notifications are sent for issues that may cause service errors or negative effects, or alert notifications for services that are relatively less important.'."\n" - .'* P4: Alert notifications are sent for low-priority issues that do not affect your business.'."\n" - .'* Default: Alert notifications are sent regardless of alert levels.'."\n", - 'type' => 'string', - 'example' => 'P2', - ], - 'Message' => [ - 'title' => 'Prometheus告警-告警内容', - 'description' => 'The alert message of the Prometheus alert rule.'."\n", - 'type' => 'string', - 'example' => 'Namespace: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / Container: {{$labels.container}} CPU usage: {{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%. Current value: {{ printf "%.2f" $value }}%'."\n", - ], - 'Labels' => [ - 'title' => 'Prometheus告警-Label', - 'description' => 'The tags of the Prometheus alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '键', - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Value' => [ - 'title' => '值', - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], - ], - ], - ], - 'Annotations' => [ - 'title' => 'Prometheus告警-Annotation', - 'description' => 'The annotations of the Prometheus alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The annotation struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'title' => '键', - 'description' => 'The key of the annotation.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Value' => [ - 'title' => '值', - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => 'abc', - ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Tags' => [ - 'description' => 'The tags of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'type', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'prod', - ], - ], + 'Notice' => [ + 'description' => 'The time ranges when the alert rule takes effect and when alert notifications are sent.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndTime' => ['description' => 'The end of the time range when the alert rule takes effect within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1480607940000', 'title' => ''], + 'NoticeEndTime' => ['description' => 'The end of the time range when alert notifications are sent based on the alert rule within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1480607940000', 'title' => ''], + 'StartTime' => ['description' => 'The beginning of the time range when the alert rule takes effect within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1480521600000', 'title' => ''], + 'NoticeStartTime' => ['description' => 'The beginning of the time range when alert notifications are sent based on the alert rule within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1480521600000', 'title' => ''], ], + 'title' => '', + 'example' => '', ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"337B8F7E-0A64-5768-9225-E9B3CF******\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertRules\\": [\\n {\\n \\"AlertId\\": 0,\\n \\"AlertName\\": \\"arms-test\\",\\n \\"UserId\\": \\"1131971649******\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AlertType\\": \\"APPLICATION_MONITORING_ALERT_RULE\\",\\n \\"AlertStatus\\": \\"RUNNING\\",\\n \\"CreatedTime\\": 1640333981000,\\n \\"UpdatedTime\\": 1640333981000,\\n \\"Extend\\": \\"{\\\\\\\\\\\\\\"alarmContext\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"报警名称:$报警名称\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n筛选条件: $筛选\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警时间: $报警时间\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n报警内容: $报警内容\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\",\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"subTitle\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"}\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alertWays\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"[0,1]\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"contactGroupIds\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"381,5075\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"notice\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"endTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeEndTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480607940000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"noticeStartTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000,\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"startTime\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\":1480521600000}\\\\\\\\\\\\\\"}\\",\\n \\"NotifyStrategy\\": \\"ALERT_MANAGER\\",\\n \\"Pids\\": [\\n \\"[\\\\\\"b590lhguqs@40d8deedfa9******\\\\\\"]\\"\\n ],\\n \\"AutoAddNewApplication\\": false,\\n \\"MetricsType\\": \\"JVM\\",\\n \\"AlertRuleContent\\": {\\n \\"Condition\\": \\"OR\\",\\n \\"AlertRuleItems\\": [\\n {\\n \\"N\\": 1,\\n \\"MetricKey\\": \\"appstat.jvm.non_heap_used\\",\\n \\"Aggregate\\": \\"AVG\\",\\n \\"Operator\\": \\"CURRENT_GTE\\",\\n \\"Value\\": \\"1\\"\\n }\\n ]\\n },\\n \\"Filters\\": {\\n \\"DimFilters\\": [\\n {\\n \\"FilterKey\\": \\"rootIp\\",\\n \\"FilterOpt\\": \\"ALL\\",\\n \\"FilterValues\\": [\\n \\"null\\"\\n ]\\n }\\n ],\\n \\"CustomSLSFilters\\": [\\n {\\n \\"Key\\": \\"username\\",\\n \\"Opt\\": \\"=\\",\\n \\"Value\\": \\"test\\",\\n \\"T\\": \\"null\\",\\n \\"Show\\": false\\n }\\n ],\\n \\"CustomSLSGroupByDimensions\\": [\\n \\"[\\\\\\"page\\\\\\"]\\"\\n ],\\n \\"CustomSLSWheres\\": [\\n \\"[\\\\\\"t like \'%api%\'\\\\\\"]\\"\\n ]\\n },\\n \\"AlertCheckType\\": \\"STATIC\\",\\n \\"ClusterId\\": \\"ceba9b9ea5b924dd0b6726d2de6******\\",\\n \\"AlertGroup\\": 1,\\n \\"PromQL\\": \\"node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100\\",\\n \\"Duration\\": \\"1\\",\\n \\"Level\\": \\"P2\\",\\n \\"Message\\": \\"命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} CPU使用率{{$labels.metrics_params_opt_label_value}} {{$labels.metrics_params_value}}%, 当前值{{ printf \\\\\\"%.2f\\\\\\" $value }}%\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"123\\",\\n \\"Value\\": \\"abc\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"type\\",\\n \\"Value\\": \\"prod\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<GetAlertRulesResponse>\\n <PageBean>\\n <AlertRules>\\n <AlertName>test</AlertName>\\n <CreatedTime>1641438611000</CreatedTime>\\n <AlertRuleContent>\\n <Condition>OR</Condition>\\n <AlertRuleItems>\\n <Operator>CURRENT_GTE</Operator>\\n <MetricKey>appstat.jvm.non_heap_used</MetricKey>\\n <Value>1</Value>\\n <Aggregate>AVG</Aggregate>\\n <N>1</N>\\n </AlertRuleItems>\\n </AlertRuleContent>\\n <NotifyStrategy>ALERT_MANAGER</NotifyStrategy>\\n <Pids>19f4e346-8712-43b7-b19d-6f230a******</Pids>\\n <AlertType>APPLICATION_MONITORING_ALERT_RULE</AlertType>\\n <AlertId>12345</AlertId>\\n <Filters>\\n <DimFilters>\\n <FilterOpt>ALL</FilterOpt>\\n <FilterKey>rootIp</FilterKey>\\n </DimFilters>\\n </Filters>\\n <UserId>10983*********</UserId>\\n <AlertStatus>RUNNING</AlertStatus>\\n <AutoAddNewApplication>false</AutoAddNewApplication>\\n <RegionId>cn-hangzhou</RegionId>\\n <UpdatedTime>1641438611000</UpdatedTime>\\n </AlertRules>\\n <Size>20</Size>\\n <Total>1</Total>\\n <Page>1</Page>\\n </PageBean>\\n <RequestId>19AF18E1-DAEB-5F4C-BC8B-E3F475******</RequestId>\\n</GetAlertRulesResponse>","errorExample":""}]', - 'title' => 'GetAlertRules', - 'extraInfo' => '### More examples'."\n" + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 23,\\n \\"AlertRules\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"UpdateTime\\": 1480521600000,\\n \\"ContactGroupIdList\\": \\"381*,572*\\",\\n \\"CreateTime\\": 1579508519683,\\n \\"AlertTitle\\": \\"TestAlertRule\\",\\n \\"UserId\\": \\"113197164949****\\",\\n \\"AlertVersion\\": 1,\\n \\"HostByAlertManager\\": true,\\n \\"AlertType\\": 4,\\n \\"ContactGroupIds\\": \\"[123, 234]\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"continuous\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"dataRevision\\\\\\\\\\\\\\":2}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AlertLevel\\": \\"WARN\\",\\n \\"TaskStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Title\\": \\"AlertTest\\",\\n \\"TaskId\\": 123,\\n \\"Id\\": 123,\\n \\"AlertWays\\": [\\n \\"[\\\\\\"MAIL\\\\\\", \\\\\\"SMS\\\\\\", \\\\\\"DING_ROBOT\\\\\\"]\\"\\n ],\\n \\"AlarmContext\\": {\\n \\"AlarmContentTemplate\\": \\"报警名称：$报警名称\\\\\\\\n筛选条件：$筛选\\\\\\\\n报警时间：$报警时间\\\\\\\\n报警内容：$报警内容\\\\\\\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\",\\n \\"SubTitle\\": \\"test\\",\\n \\"AlarmContentSubTitle\\": \\"TestSubTitle\\",\\n \\"Content\\": \\"报警名称：$报警名称\\\\\\\\n筛选条件：$筛选\\\\\\\\n报警时间：$报警时间\\\\\\\\n报警内容：$报警内容\\\\\\\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\"\\n },\\n \\"AlertRule\\": {\\n \\"Operator\\": \\"|\\",\\n \\"Rules\\": [\\n {\\n \\"Measure\\": \\"appstat.jvm.SystemDiskFree\\",\\n \\"Value\\": 30,\\n \\"Aggregates\\": \\"AVG\\",\\n \\"NValue\\": 5,\\n \\"Operator\\": \\"CURRENT_GTE\\",\\n \\"Alias\\": \\"调用响应时间_ms\\"\\n }\\n ]\\n },\\n \\"MetricParam\\": {\\n \\"Type\\": \\"DB\\",\\n \\"AppGroupId\\": \\"DEFAULT\\",\\n \\"AppId\\": \\"123\\",\\n \\"Pid\\": \\"9870ca99-8105-4da7-a3a4-d72dd1b1****\\",\\n \\"Dimensions\\": [\\n {\\n \\"Key\\": \\"rootIp\\",\\n \\"Type\\": \\"DISABLE\\",\\n \\"Value\\": \\"\\\\\\"127.0.0.1\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Notice\\": {\\n \\"EndTime\\": 1480607940000,\\n \\"NoticeEndTime\\": 1480607940000,\\n \\"StartTime\\": 1480521600000,\\n \\"NoticeStartTime\\": 1480521600000\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + 'title' => 'SearchAlertRules', + 'description' => 'The current operation is no longer maintained. You can call the GetAlertRules operation of Alert Management (New) to query existing alert rules.'."\n", + 'requestParamsDescription' => '### Mappings between **RegionId** and **SystemRegionId**'."\n" ."\n" - .'### Obtain the Browser Monitoring alert rules of the China (Hangzhou) region'."\n" + .'The SearchAlertRules operation obtains the alert rules of the specified region based on the value specified for **SystemRegionId**.'."\n" ."\n" - .'**Sample request**'."\n" + .'* If the **SystemRegionId** parameter is not specified, the backend automatically uses the **RegionId** value as the **SystemRegionId** value.'."\n" + .'* If the **SystemRegionId** parameter is specified, **RegionId** must be specified based on the following mappings. Otherwise, data cannot be returned.'."\n" ."\n" - .' http(s)://[Endpoint]/?Action=GetAlertRules'."\n" - .' &AlertIds=["12345"]'."\n" - .' &AlertNames=["Default alert rule for Browser Monitoring"]'."\n" - .' &RegionId=cn-hangzhou'."\n" - .' &AlertType=BROWSER_MONITORING_ALERT_RULE'."\n" - .' &AlertStatus=STOPPED'."\n" - .' &Page=1'."\n" - .' &Size=20'."\n" - .' &Common request parameters'."\n" + .'|RegionId|SystemRegionId|'."\n" + .'|---|---|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-hangzhou: China (Hangzhou)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-shanghai: China (Shanghai)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-qingdao: China (Qingdao)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-beijing: China (Beijing)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-zhangjiakou: China (Zhangjiakou)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-huhehaote: China (Hohhot)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-shenzhen: China (Shenzhen)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-chengdu: China (Chengdu)|'."\n" + .'|cn-hangzhou: China (Hangzhou)|cn-hongkong: China (Hong Kong)|'."\n" + .'|ap-southeast-1: Singapore|ap-southeast-1: Singapore|'."\n" + .'|ap-southeast-1: Singapore|ap-southeast-2: Australia (Sydney)|'."\n" + .'|ap-southeast-1: Singapore|ap-southeast-3: Malaysia (Kuala Lumpur)|'."\n" + .'|ap-southeast-1: Singapore|ap-southeast-5: Indonesia (Jakarta)|'."\n" + .'|ap-southeast-1: Singapore|ap-south-1: India (Mumbai)|'."\n" + .'|ap-southeast-1: Singapore|me-east-1: UAE (Dubai)|'."\n" + .'|ap-southeast-1: Singapore|ap-southeast-6: Philippines (Manila)|'."\n" + .'|ap-northeast-1: Japan (Tokyo)|ap-northeast-1: Japan (Tokyo)|'."\n" + .'|us-west-1: US (Silicon Valley)|us-west-1: US (Silicon Valley)|'."\n" + .'|us-west-1: US (Silicon Valley)|us-east-1: US (Virginia)|'."\n" + .'|eu-west-1: UK (London)|eu-central-1: Germany (Frankfurt)|'."\n" + .'|eu-west-1: UK (London)|eu-west-1: UK (London)|'."\n" + .'|cn-hangzhou-finance: China East 1 Finance|cn-shanghai-finance-1: China East 2 Finance|'."\n" + .'|cn-hangzhou-finance: China East 1 Finance|cn-hangzhou-finance: China East 1 Finance|'."\n" + ."\n\n" + .'For example, you can perform the following operations to query the alert data of the China (Shanghai) region:'."\n" ."\n" - .'**Sample response**'."\n" + .'* Set **RegionId** to **cn-shanghai** if the **SystemRegionId** parameter is not specified.'."\n" + .'* Set **RegionId** to **cn-hangzhou** and **SystemRegionId** to **cn-shanghai**.'."\n" ."\n" - .' {'."\n" - .' "PageBean": {'."\n" - .' "AlertRules": ['."\n" - .' {'."\n" - .' "AlertId": 12345,'."\n" - .' "AlertName": "Default alert rule for Browser Monitoring",'."\n" - .' "AlertRuleContent": {'."\n" - .' "AlertRuleItems": ['."\n" - .' {'."\n" - .' "Aggregate": "AVG",'."\n" - .' "MetricKey": "webstat.jsError.rate",'."\n" - .' "N": 10,'."\n" - .' "Operator": "CURRENT_GTE",'."\n" - .' "Value": 0.2'."\n" - .' },'."\n" - .' {'."\n" - .' "Aggregate": "SUM",'."\n" - .' "MetricKey": "webstat.jsError.count",'."\n" - .' "N": 10,'."\n" - .' "Operator": "CURRENT_GTE",'."\n" - .' "Value": 20.0'."\n" - .' }'."\n" - .' ],'."\n" - .' "Condition": "AND"'."\n" - .' },'."\n" - .' "AlertStatus": "STOPPED",'."\n" - .' "AlertType": "BROWSER_MONITORING_ALERT_RULE",'."\n" - .' "AutoAddNewApplication": false,'."\n" - .' "CreatedTime": 1625824851000,'."\n" - .' "Extend": "{\\"alarmContext\\":\\"{\\\\\\"content\\\\\\":\\\\\\"Alert name: $Alert name\\\\\\\\\\\\\\\\nFilter condition: $Filter condition\\\\\\\\\\\\\\\\nAlert time: $Alert time\\\\\\\\\\\\\\\\nAlert content: $Alert content\\\\\\\\\\\\\\\\nNote: The alert persists before you receive an email that reminds you to clear the alert. You will be reminded of the alert again 24 hours later. \\\\\\",\\\\\\"subTitle\\\\\\":\\\\\\"\\\\\\"}\\",\\"alertWays\\":\\"[0,1]\\",\\"contactGroupIds\\":\\"299\\",\\"notice\\":\\"{\\\\\\"endTime\\\\\\":1480607940000,\\\\\\"noticeEndTime\\\\\\":1480607940000,\\\\\\"noticeStartTime\\\\\\":1480521600000,\\\\\\"startTime\\\\\\":1480521600000}\\"}",'."\n" - .' "Filters": {'."\n" - .' "DimFilters": ['."\n" - .' {'."\n" - .' "FilterKey": "page",'."\n" - .' "FilterOpt": "ALL",'."\n" - .' "FilterValues": ['."\n" - .' null'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "MetricsType": "page",'."\n" - .' "Pids": ['."\n" - .' "aokcdqn3ly@6a6c*******"'."\n" - .' ],'."\n" - .' "RegionId": "cn-hangzhou",'."\n" - .' "UpdatedTime": 1625824851000,'."\n" - .' "UserId": "1084*********"'."\n" - .' }'."\n" - .' ],'."\n" - .' "Size": 20,'."\n" - .' "Total": 1,'."\n" - .' "Page": 1'."\n" - .' },'."\n" - .' "RequestId": "A87CE2E7-8115-5A9C-8F4B-7C9DD7******"'."\n" - .' }'."\n" + .'To query the alert rules of the Germany (Frankfurt) region, set **RegionId** to **eu-west-1** and **SystemRegionId** to **eu-central-1**.', + 'responseParamsDescription' => '## Alert metrics'."\n" ."\n" - .'### Obtain the Prometheus alert rules of the China (Hangzhou) region'."\n" + .'* Alert type (metricParam.type): txn'."\n" ."\n" - .'**Sample request**'."\n" + .' * Dimension (dimensions.key): rpc'."\n" ."\n" - .' http(s)://[Endpoint]/?Action=GetAlertRules'."\n" - .' &AlertIds=["12345"]'."\n" - .' &AlertNames=["Disk usage of the Elasticsearch node exceeds 85%"]'."\n" - .' &RegionId=cn-hangzhou'."\n" - .' &AlertType=PROMETHEUS_MONITORING_ALERT_RULE'."\n" - .' &AlertStatus=RUNNING'."\n" - .' &Page=1'."\n" - .' &Size=20'."\n" - .' &Common request parameters'."\n" + .' * Metrics (alertRule.rules.measure):'."\n" ."\n" - .'**Sample response**'."\n" + .' * appstat.txn.rt: the response time of API calls (Unit: milliseconds)'."\n" + .' * appstat.txn.count: the number of API calls'."\n" + .' * appstat.txn.errcount: the number of API call errors'."\n" ."\n" - .' {'."\n" - .' "PageBean": {'."\n" - .' "AlertRules": ['."\n" - .' {'."\n" - .' "AlertName": "Disk usage of the Elasticsearch node exceeds 85%",'."\n" - .' "CreatedTime": 1643188668035,'."\n" - .' "Message": "Cluster ID: {{$labels.cluster_id}} Node IP address: {{$labels.node_id}} Disk usage Current value {{ printf \\"%.2f\\" $value }}%\\nFor more information, see https://elasticsearch.console.aliyun.com/{{$labels.region}}/instances/{{$labels.cluster_id}}/base",'."\n" - .' "ClusterId": "n9p9****",'."\n" - .' "PromQL": "arms_cms_es_node_disk_utilization > 85",'."\n" - .' "AlertCheckType": "CUSTOM",'."\n" - .' "AlertRuleContent": {},'."\n" - .' "NotifyStrategy": "ALERT_MANAGER",'."\n" - .' "Duration": 10,'."\n" - .' "Labels": ['."\n" - .' {'."\n" - .' "Value": "cms_es",'."\n" - .' "Name": "_aliyun_cloud_product"'."\n" - .' }'."\n" - .' ],'."\n" - .' "AlertType": "PROMETHEUS_MONITORING_ALERT_RULE",'."\n" - .' "AlertId": 12345,'."\n" - .' "AlertGroup": -1,'."\n" - .' "Filters": {},'."\n" - .' "Annotations": ['."\n" - .' {'."\n" - .' "Value": "Disk usage of the Elasticsearch node",'."\n" - .' "Name": "_aliyun_display_name"'."\n" - .' },'."\n" - .' {'."\n" - .' "Value": "Cluster ID: {{$labels.cluster_id}} Node IP address: {{$labels.node_id}} Disk usage Current value {{ printf \\"%.2f\\" $value }}%\\nFor more information, see https://elasticsearch.console.aliyun.com/{{$labels.region}}/instances/{{$labels.cluster_id}}/base",'."\n" - .' "Name": "message"'."\n" - .' },'."\n" - .' {'."\n" - .' "Value": "arms_cms_es_node_disk_utilization",'."\n" - .' "Name": "_aliyun_display_promql"'."\n" - .' }'."\n" - .' ],'."\n" - .' "Extend": "",'."\n" - .' "UserId": "10983*********",'."\n" - .' "AlertStatus": "RUNNING",'."\n" - .' "Level": "P6",'."\n" - .' "RegionId": "cn-hangzhou",'."\n" - .' "UpdatedTime": 1643188668035'."\n" - .' }'."\n" - .' ],'."\n" - .' "Size": 20,'."\n" - .' "Total": 1,'."\n" - .' "Page": 1'."\n" - .' },'."\n" - .' "RequestId": "A87CE2E7-8115-5A9C-8F4B-7C9DD7******"'."\n" - .' }'."\n", - ], - 'CreateOrUpdateContact' => [ - 'summary' => 'Creates or modifies an alert contact.', - 'methods' => [ - 'get', - 'post', + .'* Alert type (metricParam.type): txn_type'."\n" + ."\n" + .' * Dimension (dimensions.key): rpcType'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.inbound.rt: the response time of API calls for services that are provided by the application (Unit: milliseconds)'."\n" + .' * appstat.inbound.count: the number of API calls for services that are provided by the application'."\n" + .' * appstat.inbound.error: the number of API call errors for services that are provided by the application'."\n" + .' * appstat.outbound.rt: the response time of API calls for services on which the application depends (Unit: milliseconds)'."\n" + .' * appstat.outbound.count: the number of API calls for services on which the application depends'."\n" + .' * appstat.outbound.error: the number of API call errors for services on which the application depends'."\n" + ."\n" + .'* Alert type (metricParam.type): db'."\n" + ."\n" + .' * Dimension (dimensions.key): endpoint'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.database.rt: the response time of API calls for the database'."\n" + .' * appstat.database.count: the number of API calls for the database'."\n" + .' * appstat.database.errcount: the number of API call errors for the database'."\n" + ."\n" + .'* Alert type (metricParam.type): jvm'."\n" + ."\n" + .' * Dimension (dimensions.key): rootIp'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.jvm.heap_used: the total memory space in the JVM heap (Unit: bytes)'."\n" + .' * appstat.jvm.GcPsScavengeCount: the number of garbage collections (GCs) in JVM'."\n" + .' * appstat.jvm.GcPsMarkSweepCount: the number of tag deletions in JVM'."\n" + .' * appstat.jvm.GcG1OldGenCount: the number of Garbage-First (G1) GCs in the old generation'."\n" + .' * appstat.jvm.GcG1YoungGenCount: the number of G1 GCs in the young generation'."\n" + .' * appstat.jvm.gc.YoungGcCountInstant: the number of GCs in the young generation'."\n" + .' * appstat.jvm.gc.OldGcCountInstant: the number of full heap GCs (Full GCs) in JVM'."\n" + .' * appstat.jvm.gc.YoungGcTimeInstant: the time that is consumed for the GCs in the young generation (Unit: milliseconds)'."\n" + .' * appstat.jvm.gc.OldGcTimeInstant: the time that is consumed for the Full GCs in JVM (Unit: milliseconds)'."\n" + .' * appstat.jvm.ThreadCount: the total number of JVM threads'."\n" + .' * appstat.jvm.non_heap_used: the used space of the non-heap JVM memory (Unit: bytes)'."\n" + .' * appstat.jvm.non_heap_max: the maximum space of the non-heap JVM memory (Unit: bytes)'."\n" + .' * appstat.jvm.non_heap_init: the initial space of the non-heap JVM memory (Unit: bytes)'."\n" + .' * appstat.jvm.non_heap_committed: the submitted space of the non-heap JVM memory (Unit: bytes)'."\n" + ."\n" + .'* Alert type (metricParam.type): host'."\n" + ."\n" + .' * Dimension (dimensions.key): rootIp'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.jvm.SystemCpuUser: the CPU usage of the host (Unit: percentage)'."\n" + .' * appstat.jvm.SystemMemFree: the idle memory space of the host (Unit: bytes)'."\n" + .' * appstat.jvm.SystemDiskFree: the idle disk space of the host (Unit: bytes)'."\n" + .' * appstat.jvm.SystemNetInErrs: the number of error messages that are received by the host'."\n" + .' * appstat.jvm.SystemNetOutErrs: the number of error messages that are sent by the host'."\n" + .' * appstat.jvm.SystemLoad: the system load of the host'."\n" + ."\n" + .'* Alert type (metricParam.type): exception'."\n" + ."\n" + .' * Dimension (dimensions.key): rpc'."\n" + ."\n" + .' * Metrics (alertRule.rules.measure):'."\n" + ."\n" + .' * appstat.exception.rt: the response time of abnormal API calls for the application (Unit: milliseconds)'."\n" + .' * appstat.exception.count: the number of abnormal API calls for the application'."\n", + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-07-14T01:53:11.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-18T01:54:45.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2021-12-24T13:33:34.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAlertRules'], + ], ], + ], + 'SearchEvents' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38487,283 +26835,171 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ContactId', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人ID', - 'description' => 'The ID of the alert contact.'."\n" - ."\n" - .'* If you do not specify this parameter, a new alert contact is created.'."\n" - .'* If you specify this parameter, the specified alert contact is modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule. You can call the SearchAlertRules operation and view the `Id` parameter in the response. For more information, see [SearchAlertRules](~~175825~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '123', 'title' => ''], ], [ - 'name' => 'ContactName', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人名称', - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'JohnDoe', - ], + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The process identifier (PID) of the application that is associated with the alert rule.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'Phone', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人手机号码', - 'description' => 'The mobile number of the alert contact.'."\n" - ."\n" - .'> You must specify at least one of the **Phone** and **Email** parameters. Each mobile number or email address can be used for only one alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1381111****', - ], + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return. Default value: `1`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Email', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人邮箱', - 'description' => 'The email address of the alert contact.'."\n" - ."\n" - .'> You must specify at least one of the **Phone** and **Email** parameters. Each mobile number or email address can be used for only one alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'someone@example.com', - ], + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Default value: `10`.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '10', 'title' => ''], ], [ - 'name' => 'ReissueSendNotice', - 'in' => 'formData', - 'schema' => [ - 'title' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', - 'description' => 'The operation that you want to perform if phone calls fail to be answered. Valid values:'."\n" - ."\n" - .'* 0: No operation is performed.'."\n" - .'* 1: A phone call is made again.'."\n" - .'* 2: A text message is sent.'."\n" - .'* 3 (default value): The global default value is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '3', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'IsEmailVerify', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Specifies whether the email address is verified.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'AppType', + 'in' => 'query', + 'schema' => ['description' => 'The type of the application that is associated with the alert rule. Valid values:'."\n" + ."\n" + .'* `TRACE`: application monitoring'."\n" + .'* `RETCODE`: frontend monitoring'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'TRACE', 'title' => ''], ], [ - 'name' => 'DingRobotUrl', + 'name' => 'AlertType', 'in' => 'query', - 'schema' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=69d4e0******', - ], + 'schema' => ['description' => 'The type of the alert rule. Valid values:'."\n" + ."\n" + .'* `1`: custom alert rules to monitor drill-down data sets'."\n" + .'* `3`: custom alert rules to monitor tiled data sets'."\n" + .'* `4`: alert rules to monitor the frontend, including the default frontend alert rules'."\n" + .'* `5`: alert rules to monitor applications, including the default application alert rules'."\n" + .'* `6`: the default frontend alert rules'."\n" + .'* `7`: the default application alert rules'."\n" + .'* `8`: Tracing Analysis alert rules'."\n" + .'* `101`: Prometheus alert rules'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '4', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'IsTrigger', 'in' => 'query', - 'schema' => [ - 'description' => 'The resource group ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', - ], + 'schema' => ['description' => 'Specifies whether the alert event is triggered. If you do not set this parameter, all alert events are queried. Valid values:'."\n" + ."\n" + .'* `1`: The event is triggered.'."\n" + .'* `0`: The event is not triggered.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => false, 'example' => '1', 'title' => ''], ], [ - 'name' => 'CorpUserId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the alert contact that is shown to the enterprise when the contact is mentioned with the at sign (@) by a third-party instant messaging (IM) tool.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'A123221', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Specify a UNIX timestamp of the LONG data type, in milliseconds. The default value is 10 minutes before the current time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1595565300000', 'title' => ''], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Specify a UNIX timestamp of the LONG data type, in milliseconds. The default value is the current time.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'docRequired' => false, 'example' => '1595568970000', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', - ], - 'AlertContact' => [ - 'description' => 'The object of the alert contact.'."\n", + 'IsTrigger' => ['description' => 'Specifies whether the alert event is triggered. If you do not set this parameter, all alert events are queried. Valid values:'."\n" + ."\n" + .'* `1`: The event is triggered.'."\n" + .'* `0`: The event is not triggered.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '0', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '32940175-181B-4B93-966E-4BB69176****', 'title' => ''], + 'PageBean' => [ + 'description' => 'The struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'ContactId' => [ - 'title' => '告警联系人ID', - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'ContactName' => [ - 'title' => '告警联系人名称', - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'JohnDoe', - ], - 'Phone' => [ - 'title' => '告警联系人手机号', - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'Email' => [ - 'title' => '告警联系人邮箱', - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'someone@example.com', - ], - 'IsVerify' => [ - 'title' => '手机号码验证标识', - 'description' => 'Indicates whether the mobile number was verified. Valid values:'."\n" - ."\n" - .'* `false` (default value): No'."\n" - .'* `true`: Yes'."\n" - ."\n" - .'You can call the **SendTTSVerifyLink** operation to verify the mobile number of an alert contact. Only verified mobile numbers can be specified in a notification policy to receive phone calls.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReissueSendNotice' => [ - 'title' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', - 'description' => 'The operation that you want to perform if phone calls fail to be answered. Valid values: 0: No operation is performed. 1: A phone call is made again. 2: A text message is sent. 3 (default value): The global default value is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'isEmailVerify' => [ - 'description' => 'Indicates whether the email address was verified.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DingRobotUrl' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://test1.com', + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'Event' => [ + 'description' => 'The information about the alert events.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventTime' => ['description' => 'The timestamp when the event occurred.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1595569020000', 'title' => ''], + 'EventLevel' => ['description' => 'The severity of the event.'."\n", 'type' => 'string', 'example' => '1', 'title' => ''], + 'AlertRule' => ['description' => 'The condition of the alert rule.'."\n", 'type' => 'string', 'example' => '{\\"operator\\":\\"&\\",\\"rules\\":[{\\"aggregates\\":\\"AVG\\",\\"alias\\":\\"JVM_线程总数\\",\\"measure\\":\\"appstat.jvm.ThreadCount\\",\\"nValue\\":1,\\"operator\\":\\"HOH_DOWN\\",\\"value\\":50.0}]}', 'title' => ''], + 'Message' => ['description' => 'The event content. The parameter value is a JSON string. Each key indicates a dimension and each value indicates the alert content in the dimension.'."\n", 'type' => 'string', 'example' => 'unknow紧急报警\\nip：172.27.XX.XX\\n应用名 = test\\nRegion = cn-shenzhen\\n异常信息 = {\\"timestamp\\"：\\"1615447972235\\"}', 'title' => ''], + 'AlertType' => ['description' => 'The type of the alert rule. This parameter is not returned. Valid values:'."\n" + ."\n" + .'* `1`: custom alert rules to monitor drill-down data sets'."\n" + .'* `3`: custom alert rules to monitor tiled data sets'."\n" + .'* `4`: alert rules to monitor the frontend, including the default frontend alert rules'."\n" + .'* `5`: alert rules to monitor applications, including the default application alert rules'."\n" + .'* `6`: the default frontend alert rules'."\n" + .'* `7`: the default application alert rules'."\n" + .'* `8`: Tracing Analysis alert rules'."\n" + .'* `101`: Prometheus alert rules'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '4', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule that is associated with the event.'."\n", 'type' => 'string', 'example' => 'alertName', 'title' => ''], + 'Id' => ['description' => 'The ID of the event record.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule that is associated with the event.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'Links' => [ + 'description' => 'The list of event URLs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The region ID of the instance with which the connection is associated.'."\n", 'type' => 'string', 'example' => '[ "http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633®ionId=cn-hangzhou&pid=****" ]', 'title' => ''], + 'title' => '', + 'example' => '', + ], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"AlertContact\\": {\\n \\"ContactId\\": 123,\\n \\"ContactName\\": \\"JohnDoe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"IsVerify\\": false,\\n \\"ReissueSendNotice\\": 3,\\n \\"isEmailVerify\\": true,\\n \\"DingRobotUrl\\": \\"https://test1.com\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateContactResponse>\\n <RequestId>E9C9DA3D-10FE-472E-9EEF-2D0A3E41****</RequestId>\\n <AlertContact>\\n <ContactId>123</ContactId>\\n <ContactName>JohnDoe</ContactName>\\n <Phone>1381111****</Phone>\\n <Email>someone@example.com</Email>\\n <IsVerify>false</IsVerify>\\n </AlertContact>\\n</CreateOrUpdateContactResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateContact', - ], - 'SendTTSVerifyLink' => [ - 'summary' => 'Sends a text message to an alert contact to verify the mobile number of the alert contact.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], + 'title' => 'SearchEvents', + 'summary' => 'Queries alert event records.', + 'description' => 'Alert event records are different from alert notification records. Alert events are recorded every minute after an alert rule filters data. Alert events can be classified based on whether they are triggered or not. If a triggered event is not in the silence period, an alert notification is sent.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-19T06:25:25.000Z', 'description' => 'Error codes changed'], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', + 'flowControl' => [ + 'flowControlList' => [], ], - 'parameters' => [ - [ - 'name' => 'ContactId', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人ID', - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], + 'ramActions' => [ [ - 'name' => 'Phone', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人手机号码', - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '1381111****', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the text message was sent.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<SendTTSVerifyLinkResponse>\\n <RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</SendTTSVerifyLinkResponse>","errorExample":""}]', - 'title' => 'SendTTSVerifyLink', - 'description' => 'After you receive the text message, verify the mobile number as prompted. Before you can specify a mobile phone number in a notification policy, you must verify the mobile phone number.'."\n", + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsTrigger\\": 0,\\n \\"RequestId\\": \\"32940175-181B-4B93-966E-4BB69176****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Event\\": [\\n {\\n \\"EventTime\\": 1595569020000,\\n \\"EventLevel\\": \\"1\\",\\n \\"AlertRule\\": \\"{\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"&\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rules\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"aggregates\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AVG\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alias\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"JVM_线程总数\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"measure\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"appstat.jvm.ThreadCount\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nValue\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HOH_DOWN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":50.0}]}\\",\\n \\"Message\\": \\"unknow紧急报警\\\\\\\\nip：172.27.XX.XX\\\\\\\\n应用名 = test\\\\\\\\nRegion = cn-shenzhen\\\\\\\\n异常信息 = {\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\"：\\\\\\\\\\\\\\"1615447972235\\\\\\\\\\\\\\"}\\",\\n \\"AlertType\\": 4,\\n \\"AlertName\\": \\"alertName\\",\\n \\"Id\\": 123,\\n \\"AlertId\\": 123,\\n \\"Links\\": [\\n \\"[ \\\\\\"http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633®ionId=cn-hangzhou&pid=****\\\\\\" ]\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', ], - 'DeleteContact' => [ - 'summary' => 'Deletes alert contacts.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'SearchRetcodeAppByPage' => [ + 'summary' => 'Queries Browser Monitoring tasks by page.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -38771,288 +27007,158 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'title' => '告警联系人ID', - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the alert contact is deleted. Valid values:'."\n" - ."\n" - .'* `true`: The alert contact is deleted.'."\n" - .'* `false`: The alert contact is not deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteContactResponse>","errorExample":""}]', - 'title' => 'DeleteContact', - ], - 'DescribeContacts' => [ - 'summary' => 'Queries alert contacts.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '118543', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', - ], - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'RetcodeAppName', 'in' => 'query', - 'schema' => [ - 'title' => '告警联系人名称', - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'John Doe', - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'App1', 'title' => ''], ], [ - 'name' => 'Phone', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'title' => '告警联系人手机号码', - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1381111*****', - ], + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Email', - 'in' => 'query', - 'schema' => [ - 'title' => '告警联系人邮箱', - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'someone@example.com', - ], - ], - [ - 'name' => 'Page', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of entries to return on each page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '5', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of alert contacts to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ContactIds', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact that you want to query. Separate multiple contact IDs with spaces.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123,321', - ], + 'schema' => ['description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ - 'name' => 'Verbose', + 'name' => 'RetcodeAppId', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return redundant information.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The application ID.'."\n" + ."\n" + .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the browser address bar contains the pid of this application in the format of `pid=xxx`. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is `xxx%4074xxx`, you must replace **%40** with the at sign (@). The actual PID is `xxx@74xxx`.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eb4zdose6v@9781be0f44d****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', + 'description' => 'The tag.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797A64E', 'title' => ''], 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The objects that were returned.'."\n", + 'description' => 'The returned page information.'."\n", 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of alert contacts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每一页大小', - 'description' => 'The number of alert contacts returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'AlertContacts' => [ - 'title' => '告警联系人列表', - 'description' => 'The alert contacts.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '2', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '8', 'title' => ''], + 'RetcodeApps' => [ + 'description' => 'The browser monitoring tasks that are returned.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactId' => [ - 'title' => '告警联系人ID', - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'ContactName' => [ - 'title' => '告警联系人名称', - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'John Doe', - ], - 'Phone' => [ - 'title' => '告警联系人手机号码', - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'Email' => [ - 'title' => '告警联系人邮箱', - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'someone@example.com', - ], - 'IsVerify' => [ - 'title' => '手机号码是否验证标识', - 'description' => 'Indicates whether the mobile number was verified. Valid values:'."\n" - ."\n" - .'* `false`: no'."\n" - .'* `true`: yes'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ReissueSendNotice' => [ - 'title' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', - 'description' => 'The operation that you want to perform if phone calls fail to be answered. Valid values:'."\n" - ."\n" - .'* 0: No operation is performed.'."\n" - .'* 1: A phone call is made again.'."\n" - .'* 2: A text message is sent.'."\n" - .'* 3 (default value): The global default value is used.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3', - ], - 'IsEmailVerify' => [ - 'description' => 'Indicates whether the email address was verified.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'ArmsContactId' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100147', + 'Type' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'* `TRACE`: Application Monitoring'."\n" + .'* `RETCODE`: Browser Monitoring'."\n", 'type' => 'string', 'example' => 'RETCODE', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'a3', 'title' => ''], + 'RetcodeAppType' => ['description' => 'The type of the application. Valid values:'."\n" + ."\n" + .'* `web`: web application'."\n" + .'* `weex`: Weex mobile app'."\n" + .'* `mini_dd`: DingTalk mini program'."\n" + .'* `mini_alipay`: Alipay mini program'."\n" + .'* `mini_wx`: WeChat mini program'."\n" + .'* `mini_common`: mini program on other platforms'."\n", 'type' => 'string', 'example' => 'web', 'title' => ''], + 'UpdateTime' => ['description' => 'The time when the task was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1545363321000', 'title' => ''], + 'CreateTime' => ['description' => 'The time when the task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1545363321000', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'eb4zdose6v@9781be0f44d****', 'title' => ''], + 'AppId' => ['description' => 'The ID of the application. The parameter is an auto-increment parameter.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '16064', 'title' => ''], + 'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '12341234', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'NickName' => ['description' => 'The alias of the application.'."\n", 'type' => 'string', 'example' => 'c1', 'title' => ''], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], + 'Tags' => [ + 'description' => 'The tag.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', ], ], 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertContacts\\": [\\n {\\n \\"ContactId\\": 123,\\n \\"ContactName\\": \\"John Doe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"IsVerify\\": false,\\n \\"ReissueSendNotice\\": 3,\\n \\"IsEmailVerify\\": true,\\n \\"ArmsContactId\\": 100147\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactsResponse>\\n <RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <AlertContacts>\\n <ContactId>123</ContactId>\\n <ContactName>John Doe</ContactName>\\n <Phone>1381111****</Phone>\\n <Email>someone@example.com</Email>\\n <IsVerify>false</IsVerify>\\n </AlertContacts>\\n </PageBean>\\n</DescribeContactsResponse>","errorExample":""}]', - 'title' => 'DescribeContacts', - ], - 'CreateOrUpdateContactGroup' => [ - 'summary' => 'Creates or modifies an alert contact group.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797A64E\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 2,\\n \\"TotalCount\\": 8,\\n \\"RetcodeApps\\": [\\n {\\n \\"Type\\": \\"RETCODE\\",\\n \\"AppName\\": \\"a3\\",\\n \\"RetcodeAppType\\": \\"web\\",\\n \\"UpdateTime\\": 1545363321000,\\n \\"CreateTime\\": 1545363321000,\\n \\"Pid\\": \\"eb4zdose6v@9781be0f44d****\\",\\n \\"AppId\\": 16064,\\n \\"UserId\\": \\"12341234\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"NickName\\": \\"c1\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\",\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchRetcodeAppByPageResponse>\\n<PageBean>\\n <TotalCount>8</TotalCount>\\n <PageSize>2</PageSize>\\n <PageNumber>1</PageNumber>\\n <RetcodeApps>\\n <Type>RETCODE</Type>\\n <AppId>16064</AppId>\\n <UserId>12341234</UserId>\\n <CreateTime>1545363321000</CreateTime>\\n <UpdateTime>1545363321000</UpdateTime>\\n <Pid>aokcdqn3ly@741623b4e91****</Pid>\\n <RegionId>cn-hangzhou</RegionId>\\n <AppName>a3</AppName>\\n </RetcodeApps>\\n</PageBean>\\n<RequestId>626037F5-FDEB-45B0-804C-B3C92797A64E</RequestId>\\n</SearchRetcodeAppByPageResponse>","errorExample":""}]', + 'title' => 'SearchRetcodeAppByPage', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-12-26T08:02:12.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-09-27T12:53:01.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SearchTraceAppByName' => [ + 'summary' => 'Queries Application Monitoring tasks by application name.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39060,103 +27166,132 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'get'], 'parameters' => [ [ - 'name' => 'ContactGroupId', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人组ID', - 'description' => 'The ID of the alert contact group.'."\n" - ."\n" - .'* If you do not specify this parameter, an alert contact group is created.'."\n" - .'* If you specify this parameter, the specified alert contact group is modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'TraceAppName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.'."\n" + ."\n" + .'> If you do not specify this parameter, all application monitoring tasks in the specified region are queried.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], [ - 'name' => 'ContactGroupName', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警联系人组名称', - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'TestGroup', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ContactIds', - 'in' => 'formData', + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '告警联系人ids', - 'description' => 'The ID of the contact that you want to add to the contact group. Separate multiple IDs with commas (,).'."\n", - 'type' => 'string', + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '[1,2,3]', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', - ], - 'AlertContactGroup' => [ - 'description' => 'The information about the alert contact group.'."\n", - 'type' => 'object', - 'properties' => [ - 'ContactGroupId' => [ - 'title' => '告警联系人组ID', - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'ContactGroupName' => [ - 'title' => '告警联系人组名称', - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => 'TestGroup', - ], - 'ContactIds' => [ - 'title' => '告警联系人ids', - 'description' => 'The IDs of the contacts that are included in the alert contact group.'."\n", - 'type' => 'string', - 'example' => '[1,2,3]', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', 'title' => ''], + 'TraceApps' => [ + 'description' => 'The information about the monitoring task.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'* `TRACE`: Application Monitoring'."\n" + .'* `RETCODE`: Browser Monitoring'."\n", 'type' => 'string', 'example' => 'TRACE', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp generated when the task information was updated.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593486786000', 'title' => ''], + 'Show' => ['description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" + ."\n" + .'* `true`: yes'."\n" + .'* `false`: no'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp generated when the task was created.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1593486786000', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.'."\n", 'type' => 'string', 'example' => 'a5f9bdeb-2627-4dbe-9247-****', 'title' => ''], + 'AppId' => ['description' => 'The application ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'UserId' => ['description' => 'The user ID.'."\n", 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Labels' => [ + 'description' => 'The aliases of the application.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The alias of the application.'."\n", 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'Tags' => [ + 'description' => 'A list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.'."\n", 'type' => 'string', 'example' => 'TestValue', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'title' => '', + 'example' => '', + ], + 'ResourceGroupId' => ['description' => 'The ID of the resource group.'."\n", 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\",\\n \\"AlertContactGroup\\": {\\n \\"ContactGroupId\\": 123,\\n \\"ContactGroupName\\": \\"TestGroup\\",\\n \\"ContactIds\\": \\"[1,2,3]\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateContactGroupResponse>\\n <RequestId>9319A57D-2D9E-472A-B69B-CF3CD16D****</RequestId>\\n <AlertContactGroup>\\n <ContactGroupId>123</ContactGroupId>\\n <ContactGroupName>TestGroup</ContactGroupName>\\n <ContactIds>[1,2,3]</ContactIds>\\n </AlertContactGroup>\\n</CreateOrUpdateContactGroupResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateContactGroup', - ], - 'DeleteContactGroup' => [ - 'summary' => 'Deletes an alert contact group.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"TraceApps\\": [\\n {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"UpdateTime\\": 1593486786000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1593486786000,\\n \\"Pid\\": \\"a5f9bdeb-2627-4dbe-9247-****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"prod\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n}","type":"json"}]', + 'title' => 'SearchTraceAppByName', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-09-18T08:33:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-06-25T09:45:48.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2023-01-03T03:37:16.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-23T04:55:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-21T09:05:02.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + ], + 'SearchTraceAppByPage' => [ + 'summary' => 'Queries Application Monitoring tasks by page.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39164,834 +27299,533 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'ContactGroupId', + 'name' => 'TraceAppName', 'in' => 'query', - 'schema' => [ - 'title' => '告警联系人组ID', - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the alert contact group was deleted. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteContactGroupResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteContactGroupResponse>","errorExample":""}]', - 'title' => 'DeleteContactGroup', - ], - 'DescribeContactGroups' => [ - 'summary' => 'Queries an alert contact group.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '118624', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', + 'schema' => ['description' => 'The name of the application.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'test-app', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ContactGroupName', - 'in' => 'query', - 'schema' => [ - 'title' => '告警联系人组名称', - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestGroup', - ], - ], - [ - 'name' => 'Page', + 'name' => 'PageNumber', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The number of the page to return. Default value: `1`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'PageSize', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of alert contact groups displayed on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The number of entries to return on each page. Default value: `10`.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'docRequired' => true, 'example' => '10', 'title' => ''], ], [ - 'name' => 'IsDetail', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '是否返回联系人分组中包含的所有联系人。默认不返回所有联系人。', - 'description' => 'Specifies whether to return all the alert contacts in the queried alert contact group. Valid values:'."\n" - ."\n" - .'* `false`'."\n" - .'* `true`'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'GroupIds', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'The resource group ID.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', + 'description' => 'A list of tags.', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'cn-hangzhou', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ + 'headers' => [], 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '4B446DF2-3DDD-4B5B-8E3F-D5225120****', 'title' => ''], 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The objects that were returned.'."\n", + 'description' => 'The information about the array object.', 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of alert contact groups.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每一页数目', - 'description' => 'The number of alert contact groups displayed on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'AlertContactGroups' => [ - 'title' => '告警联系人组列表', - 'description' => 'The name of the alert contact group.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.', 'type' => 'integer', 'format' => 'int32', 'example' => '10', 'title' => ''], + 'TotalCount' => ['description' => 'The total number of entries returned.', 'type' => 'integer', 'format' => 'int32', 'example' => '3', 'title' => ''], + 'TraceApps' => [ + 'description' => 'The information about the monitoring task.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactGroupId' => [ - 'title' => '告警联系人组ID', - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'ContactGroupName' => [ - 'title' => '告警联系人组名称', - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => 'TestGroup', + 'Type' => ['description' => 'The type of the monitoring task. Valid values:'."\n" + ."\n" + .'- `TRACE`: Application Monitoring'."\n" + ."\n" + .'- `RETCODE`: Browser Monitoring', 'type' => 'string', 'example' => 'TRACE', 'title' => ''], + 'AppName' => ['description' => 'The name of the application.', 'type' => 'string', 'example' => 'test-app', 'title' => ''], + 'UpdateTime' => ['description' => 'The timestamp generated when the task information was updated.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531291867000', 'title' => ''], + 'Show' => ['description' => 'Indicates whether the application is displayed in the Application Real-Time Monitoring Service (ARMS) console. Valid values:'."\n" + ."\n" + .'- `true`: yes'."\n" + ."\n" + .'- `false`: no', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'CreateTime' => ['description' => 'The timestamp generated when the task was created.', 'type' => 'integer', 'format' => 'int64', 'example' => '1531291867000', 'title' => ''], + 'Pid' => ['description' => 'The process identifier (PID) of the application.', 'type' => 'string', 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], + 'AppId' => ['description' => 'The application ID.', 'type' => 'integer', 'format' => 'int64', 'example' => '123', 'title' => ''], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '113197164949****', 'title' => ''], + 'RegionId' => ['description' => 'The region ID.', 'type' => 'string', 'example' => 'cn-hangzhou', 'title' => ''], + 'Labels' => [ + 'description' => 'The aliases of the application.', + 'type' => 'array', + 'items' => ['description' => 'The alias of the application.', 'type' => 'string', 'example' => 'prod', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Contacts' => [ - 'title' => '联系人对象', - 'description' => 'The contact information. If the **IsDetail** parameter is set to `false`, no **contact** information is displayed.'."\n", + 'Tags' => [ + 'description' => 'A list of tags.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'ContactId' => [ - 'title' => '联系人ID', - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '456', - ], - 'ContactName' => [ - 'title' => '联系人名称', - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'John Doe', - ], - 'Phone' => [ - 'title' => '联系人手机号码', - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'Email' => [ - 'title' => '联系人邮箱', - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'someone@example.com', - ], - 'ArmsContactId' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '100117', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'example' => 'TestValue', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], - 'ArmsContactGroupId' => [ - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '83261', - ], + 'ResourceGroupId' => ['description' => 'The resource group ID.', 'type' => 'string', 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertContactGroups\\": [\\n {\\n \\"ContactGroupId\\": 123,\\n \\"ContactGroupName\\": \\"TestGroup\\",\\n \\"Contacts\\": [\\n {\\n \\"ContactId\\": 456,\\n \\"ContactName\\": \\"John Doe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"ArmsContactId\\": 100117\\n }\\n ],\\n \\"ArmsContactGroupId\\": 83261\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeContactGroupsResponse>\\n <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <AlertContactGroups>\\n <ContactGroupId>123</ContactGroupId>\\n <ContactGroupName>TestGroup</ContactGroupName>\\n <Contacts>\\n <ContactId>456</ContactId>\\n <ContactName>John Doe</ContactName>\\n <Phone>1381111****</Phone>\\n <Email>someone@example.com</Email>\\n </Contacts>\\n </AlertContactGroups>\\n </PageBean>\\n</DescribeContactGroupsResponse>","errorExample":""}]', - 'title' => 'DescribeContactGroups', - ], - 'CreateOrUpdateIMRobot' => [ - 'summary' => 'Creates or updates an IM chatbot.', - 'methods' => [ - 'get', - 'post', + 'title' => 'SearchTraceAppByPage', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-01-03T03:37:16.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-12-21T09:05:02.000Z', 'description' => 'Response parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4B446DF2-3DDD-4B5B-8E3F-D5225120****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 3,\\n \\"TraceApps\\": [\\n {\\n \\"Type\\": \\"TRACE\\",\\n \\"AppName\\": \\"test-app\\",\\n \\"UpdateTime\\": 1531291867000,\\n \\"Show\\": true,\\n \\"CreateTime\\": 1531291867000,\\n \\"Pid\\": \\"atc889zkcf@d8deedfa9bf****\\",\\n \\"AppId\\": 123,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"Labels\\": [\\n \\"prod\\"\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"TestKey\\",\\n \\"Value\\": \\"TestValue\\"\\n }\\n ],\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n }\\n}","type":"json"}]', + ], + 'SearchTraces' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '118628', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', - ], - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RobotId', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警机器人ID', - 'description' => 'The ID of the IM chatbot.'."\n" - .'> If you do not specify the parameter, a new IM chatbot is created.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => ['description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1595174400000', 'title' => ''], ], [ - 'name' => 'RobotName', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警机器人名称', - 'description' => 'The name of the IM chatbot.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Chatbot name'."\n", - ], + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1595210400000', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警机器人类型:dingding/wechat', - 'description' => 'The type of the IM chatbot. Valid values:'."\n" - ."\n" - .'* `dingding`: DingTalk chatbot'."\n" - .'* `wechat`: WeCom chatbot'."\n" - .'* `feishu`: Lark chatbot'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'dingding', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RobotAddress', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警机器人地址', - 'description' => 'The webhook URL of the IM chatbot.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', - ], + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'arms-k8s-demo-subcomponent', 'title' => ''], ], [ - 'name' => 'DailyNoc', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否发送每日统计信息', - 'description' => 'Specifies whether to send daily statistics. Valid values:'."\n" - ."\n" - .'* `false` (default): Daily statistics are not sent.'."\n" - .'* `true`: Daily statistics are sent. If you set the value to `true`, the **DailyNocTime** parameter is required.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'OperationName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the traced span.'."\n", 'type' => 'string', 'required' => false, 'example' => '/demo/queryNotExistDB/11', 'title' => ''], ], [ - 'name' => 'DailyNocTime', - 'in' => 'formData', - 'schema' => [ - 'title' => '每日统计发送时间', - 'description' => 'The points in time at which the daily statistics are sent. Separate multiple points in time with commas (,). The points in time are in the HH:SS format. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '09:30,17:00', - ], + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], ], [ - 'name' => 'DingSignKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The signature key of DingTalk. If you specify a signature key, DingTalk authentication is performed by using the signature key. If you do not specify a signature key, a whitelist is used for authentication by default. The keyword of the whitelist is **Alert**.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '******', - ], + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" + ."\n" + .'* `true`: sorts the query results in reverse chronological order.'."\n" + .'* `false`: sorts the query results in chronological order.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'Token', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The token required to enable the Outgoing feature.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '1656558719183be1245ab44********', - ], + 'name' => 'ServiceIp', + 'in' => 'query', + 'schema' => ['description' => 'The IP address of the host where the application resides.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.20.XX.XX', 'title' => ''], ], [ - 'name' => 'EnableOutgoing', - 'in' => 'formData', + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b590lhguqs@9781be0f44dXXXX', 'title' => ''], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'Specifies whether to enable the Outgoing feature.'."\n", - 'type' => 'boolean', + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The tag key. The following system preset fields are provided:'."\n" + ."\n" + .'* serverApp: the name of the server application.'."\n" + .'* clientApp: the name of the client application.'."\n" + .'* service: the name of the operation.'."\n" + .'* rpc: the type of the call.'."\n" + .'* msOfSpan: the duration exceeds a specific value.'."\n" + .'* clientIp: the IP address of the client.'."\n" + .'* serverIp: the IP address of the server.'."\n" + .'* isError: specifies whether the call is abnormal.'."\n" + .'* hasTprof: contains only thread profiling.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http.status_code', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'true', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'CardTemplate', - 'in' => 'formData', + 'name' => 'ExclusionFilters', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '卡片模版配置信息', - 'description' => 'The configurations of the alert card template. For more information about the parameters in the template, see the following section.'."\n", - 'type' => 'string', + 'description' => 'The filter conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key that is used to filter the query results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http.status_code', 'title' => ''], + 'Value' => ['description' => 'The value of the key that is used to filter the query results.'."\n", 'type' => 'string', 'required' => false, 'example' => '404', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - 'AlertRobot' => [ - 'description' => 'The information about the IM chatbot.'."\n", - 'type' => 'object', - 'properties' => [ - 'RobotId' => [ - 'title' => '告警机器人ID', - 'description' => 'The ID of the IM chatbot.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'RobotName' => [ - 'title' => '告警机器人名称', - 'description' => 'The name of the IM chatbot.'."\n", - 'type' => 'string', - 'example' => 'Chatbot name'."\n", - ], - 'Type' => [ - 'title' => '告警机器人类型:dingding/wechat', - 'description' => 'The type of the IM chatbot. Valid values:'."\n" - ."\n" - .'* `dingding`: DingTalk chatbot'."\n" - .'* `wechat`: WeCom chatbot'."\n", - 'type' => 'string', - 'example' => 'dingding', - ], - 'RobotAddress' => [ - 'title' => '告警机器人地址', - 'description' => 'The webhook URL of the IM chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', - ], - 'DailyNoc' => [ - 'title' => '是否发送每日统计信息', - 'description' => 'Indicates whether daily statistics are sent. Valid values:'."\n" - ."\n" - .'* `false` (default): Daily statistics are not sent.'."\n" - .'* `true`: Daily statistics are sent.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DailyNocTime' => [ - 'title' => '每日统计发送时间', - 'description' => 'The point in time at which the daily statistics are sent. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.'."\n", - 'type' => 'string', - 'example' => '09:30,17:00', - ], - 'Token' => [ - 'description' => 'The token required to enable the Outgoing feature.'."\n", - 'type' => 'string', - 'example' => '1656558719183be1245ab44********'."\n", - ], - 'EnableOutgoing' => [ - 'description' => 'Indicates whether the Outgoing feature is enabled.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'CardTemplate' => [ - 'title' => '卡片模版配置信息', - 'description' => 'The configurations of the alert card template.'."\n", - 'type' => 'string', - 'example' => '{ "button": [ "claim", "close", "follow", "send_itsm", "block", "unResolvedIncident" ], "field": [ { "fieldName": "alarmName", "visible": true }, { "fieldName": "notificationPolicy", "visible": true }, { "fieldName": "alarmContent", "visible": true }, { "fieldName": "alarmTime", "visible": true }, { "fieldName": "seriesChart", "visible": true }, { "fieldName": "includeEvent", "visible": true }, { "fieldName": "assigned", "visible": true }, { "fieldName": "similarAlarm", "visible": true }, { "fieldName": "operator", "visible": true } ] }', + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', 'title' => ''], + 'TraceInfos' => [ + 'description' => 'The details of the returned traces.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperationName' => ['description' => 'The name of the traced span.'."\n", 'type' => 'string', 'example' => 'get***', 'title' => ''], + 'ServiceIp' => ['description' => 'The IP address of the host where the application resides.'."\n", 'type' => 'string', 'example' => '172.20.**.**', 'title' => ''], + 'Duration' => ['description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '6', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1595174436993', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'arms-k8s-demo-subcomponent', 'title' => ''], + 'TraceID' => ['description' => 'The trace ID.'."\n", 'type' => 'string', 'example' => 'ac1400a115951744369937024d****', 'title' => ''], + 'SpanID' => ['description' => 'Span ID. You can get it from the **Trace Explorer** page of the ARMS console.', 'type' => 'string', 'example' => 'be3d6dcf5750e***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"AlertRobot\\": {\\n \\"RobotId\\": 123,\\n \\"RobotName\\": \\"robot名称\\",\\n \\"Type\\": \\"dingding\\",\\n \\"RobotAddress\\": \\"https://oapi.dingtalk.com/robot/send?access_token=e1a049121******\\",\\n \\"DailyNoc\\": true,\\n \\"DailyNocTime\\": \\"09:30,17:00\\",\\n \\"Token\\": \\"1656558719183be1245ab44********\\\\n\\",\\n \\"EnableOutgoing\\": true,\\n \\"CardTemplate\\": \\"{ \\\\\\"button\\\\\\": [ \\\\\\"claim\\\\\\", \\\\\\"close\\\\\\", \\\\\\"follow\\\\\\", \\\\\\"send_itsm\\\\\\", \\\\\\"block\\\\\\", \\\\\\"unResolvedIncident\\\\\\" ], \\\\\\"field\\\\\\": [ { \\\\\\"fieldName\\\\\\": \\\\\\"alarmName\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"notificationPolicy\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"alarmContent\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"alarmTime\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"seriesChart\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"includeEvent\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"assigned\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"similarAlarm\\\\\\", \\\\\\"visible\\\\\\": true }, { \\\\\\"fieldName\\\\\\": \\\\\\"operator\\\\\\", \\\\\\"visible\\\\\\": true } ] }\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateIMRobotResponse>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n <AlertRobot>\\n <RobotId>123</RobotId>\\n <RobotName>robot名称</RobotName>\\n <Type>dingding</Type>\\n <RobotAddress>https://oapi.dingtalk.com/robot/send?access_token=e1a049121******</RobotAddress>\\n <DailyNoc>true</DailyNoc>\\n <DailyNocTime>09:30,17:00</DailyNocTime>\\n </AlertRobot>\\n</CreateOrUpdateIMRobotResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateIMRobot', - 'requestParamsDescription' => '### CardTemplate parameter description'."\n" - ."\n" - .'Sample template:'."\n" - ."\n" - .' {'."\n" - .' "field": ['."\n" - .' {'."\n" - .' "fieldName": "alarmName",'."\n" - .' "visible": false'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "notificationPolicy",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "alarmContent",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "alarmTime",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "seriesChart",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "includeEvent",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "assigned",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "similarAlarm",'."\n" - .' "visible": true'."\n" - .' },'."\n" - .' {'."\n" - .' "fieldName": "operator",'."\n" - .' "visible": true'."\n" - .' }'."\n" - .' ],'."\n" - .' "button": ['."\n" - .' "claim",'."\n" - .' "close",'."\n" - .' "block",'."\n" - .' "send_itsm",'."\n" - .' "unResolvedIncident",'."\n" - .' "follow"'."\n" - .' ]'."\n" - .' }'."\n" - ."\n" - .'* fieldName: the name of the field in the alert card. The following fields are included:'."\n" - ."\n" - .' * notificationPolicy: notification policy'."\n" - .' * alarmName: alert name'."\n" - .' * alarmContent: alert content'."\n" - .' * AlarmTime: the time when the alert is triggered'."\n" - .' * includeEvent: the number of events.'."\n" - .' * assigned: the users to which notifications are sent'."\n" - .' * operator: the user who handles the alert'."\n" - .' * similarAlarm: the last similar alert'."\n" - .' * seriesChart: the trend chart of the alert metrics'."\n" - ."\n" - .'* visible: specifies whether the content of the corresponding field on the alert card is visible.'."\n" - ."\n" - .' * true: visible'."\n" - .' * false: invisible'."\n" - ."\n" - .'* button: the setting button in the card. The parameter order corresponds to the card button order. The following buttons are available:'."\n" - ."\n" - .' * claim: claims alerts'."\n" - .' * close: clears alerts'."\n" - .' * follow: follows alerts'."\n" - .' * send_itsm: pushes alerts'."\n" - .' * block: blocks alerts'."\n" - .' * unResolvedIncident: unclears alerts'."\n", - ], - 'DeleteIMRobot' => [ - 'summary' => 'Deletes an instant messaging (IM) chatbot.', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"TraceInfos\\": [\\n {\\n \\"OperationName\\": \\"get***\\",\\n \\"ServiceIp\\": \\"172.20.**.**\\",\\n \\"Duration\\": 6,\\n \\"Timestamp\\": 1595174436993,\\n \\"ServiceName\\": \\"arms-k8s-demo-subcomponent\\",\\n \\"TraceID\\": \\"ac1400a115951744369937024d****\\",\\n \\"SpanID\\": \\"be3d6dcf5750e***\\"\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchTracesResponse>\\n <RequestId>4C518054-852F-4023-ABC1-4AF95FF7****</RequestId>\\n <TraceInfos>\\n <OperationName>get***</OperationName>\\n <ServiceIp>172.20.**.**</ServiceIp>\\n <Duration>6</Duration>\\n <Timestamp>1595174436993</Timestamp>\\n <ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n <TraceID>ac1400a115951744369937024d****</TraceID>\\n </TraceInfos>\\n</SearchTracesResponse>","errorExample":""}]', + 'title' => 'SearchTraces', + 'summary' => 'Queries traces by time, application name, IP address, span name, and tag.', + 'description' => '> A maximum of 100 data entries can be returned each time this operation is called. If you want to query all existing traces, we recommend that you call the SearchTracesByPage operation. For more information, see [SearchTracesByPage](~~175866~~).'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-10-08T03:39:44.000Z', 'description' => 'Response parameters changed, Response parameters changed'], + ['createdAt' => '2022-03-04T03:35:55.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'SearchTracesByPage' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RobotId', + 'name' => 'StartTime', 'in' => 'query', - 'schema' => [ - 'title' => '告警机器人ID', - 'description' => 'The ID of the IM chatbot.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1595174400000', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID. You can use the ID to find logs and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => ['description' => 'The end of the time range to query. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1595210400000', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteIMRobotResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteIMRobotResponse>","errorExample":""}]', - 'title' => 'DeleteIMRobot', - ], - 'DescribeIMRobots' => [ - 'summary' => 'Queries a list of IM chatbots.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'RobotName', + 'name' => 'ServiceName', 'in' => 'query', - 'schema' => [ - 'title' => '告警机器人名称', - 'description' => 'The name of the IM chatbot.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Chatbot name'."\n", - ], + 'schema' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'required' => false, 'example' => 'arms-k8s-demo-subcomponent', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'OperationName', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the traced span.'."\n", 'type' => 'string', 'required' => false, 'example' => '/demo/queryNotExistDB/11', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => ['description' => 'The minimum amount of time consumed by traces. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2', 'title' => ''], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to sort the query results in chronological order or reverse chronological order. Default value: `false`.'."\n" + ."\n" + .'* `true`: sorts the query results in reverse chronological order.'."\n" + .'* `false`: sorts the query results in chronological order.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], + [ + 'name' => 'ServiceIp', + 'in' => 'query', + 'schema' => ['description' => 'The IP address of the host where the application resides.'."\n", 'type' => 'string', 'required' => false, 'example' => '172.20.XX.XX', 'title' => ''], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => ['description' => 'The number of the page to return.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => ['description' => 'The number of entries to return on each page. Maximum value: 100.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '5', 'title' => ''], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The application ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'b590lhguqs@9781be0f44dXXXX', 'title' => ''], + ], + [ + 'name' => 'ExclusionFilters', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of IM chatbots to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', + 'description' => 'The filter conditions.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key that is used to filter the query results.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http.status_code', 'title' => ''], + 'Value' => ['description' => 'The value of the key that is used to filter the query results.'."\n", 'type' => 'string', 'required' => false, 'example' => '404', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'RobotIds', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The chatbot IDs.'."\n", - 'type' => 'string', + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag. The following system preset fields are provided:'."\n" + ."\n" + .'* traceId: the ID of the trace.'."\n" + .'* serverApp: the name of the server application.'."\n" + .'* clientApp: the name of the client application.'."\n" + .'* service: the name of the interface.'."\n" + .'* rpc: the type of the call.'."\n" + .'* msOfSpan: the duration exceeds a specific value.'."\n" + .'* clientIp: the IP address of the client.'."\n" + .'* serverIp: the IP address of the server.'."\n" + .'* isError: specifies whether the call is abnormal.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http.status_code', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => '123', + 'maxItems' => 5, + 'title' => '', + 'example' => '', ], ], + [ + 'name' => 'IsError', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to include the traces of abnormal calls.'."\n" + ."\n" + .'* `true`: No'."\n" + .'* `false` (default): Yes'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], + ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', 'title' => ''], 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The returned objects.'."\n", + 'description' => 'The struct returned.'."\n", 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of queried IM chatbots.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每一页数目', - 'description' => 'The number of IM chatbots returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'AlertIMRobots' => [ - 'description' => 'The queried IM chatbots.'."\n", + 'PageNumber' => ['description' => 'The page number of the returned page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'PageSize' => ['description' => 'The number of entries returned per page.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '5', 'title' => ''], + 'Total' => ['description' => 'The total number of returned entries.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '1601', 'title' => ''], + 'TraceInfos' => [ + 'description' => 'The details of the returned traces.'."\n", 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'RobotId' => [ - 'title' => '告警机器人ID', - 'description' => 'The ID of the IM chatbot.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'Type' => [ - 'title' => '告警机器人类型', - 'description' => 'The type of the IM chatbot. Valid values:'."\n" - ."\n" - .'* `dingding`: DingTalk chatbot'."\n" - .'* `wechat`: WeCom chatbot'."\n", - 'type' => 'string', - 'example' => 'dingding', - ], - 'RobotName' => [ - 'title' => '告警机器人名称', - 'description' => 'The name of the IM chatbot.'."\n", - 'type' => 'string', - 'example' => 'Chatbot name'."\n", - ], - 'RobotAddr' => [ - 'title' => '告警机器人地址', - 'description' => 'The webhook URL of the IM chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', - ], - 'DailyNoc' => [ - 'title' => '是否发送每日统计信息', - 'description' => 'Indicates whether daily statistics are sent. Valid values:'."\n" - ."\n" - .'* `false` (default): Daily statistics are not sent.'."\n" - .'* `true`: Daily statistics are sent.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'DailyNocTime' => [ - 'title' => '每日统计发送时间', - 'description' => 'The point in time at which the daily statistics are sent. The information that ARMS sends at the specified points in time includes the total number of alerts generated on the current day, the number of cleared alerts, and the number of alerts to be cleared.'."\n", - 'type' => 'string', - 'example' => '09:30,17:30', - ], - 'DingSignKey' => [ - 'description' => 'The signature key of DingTalk. If you specify a signature key, DingTalk authentication is performed by using the signature key. If you do not specify a signature key, a whitelist is used for authentication by default. The keyword of the whitelist is **Alert**.'."\n", - 'type' => 'string', - 'example' => '******', - ], - 'CreateTime' => [ - 'description' => 'The time when the IM chatbot was created.'."\n", - 'type' => 'string', - 'example' => '2023-01-16 17:21:48', - ], - 'DispatchRules' => [ - 'description' => 'The notification policies.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'id' => [ - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '12345', - ], - 'name' => [ - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'Notification policy test'."\n", - ], - ], - ], - ], + 'OperationName' => ['description' => 'The name of the traced span.'."\n", 'type' => 'string', 'example' => '/demo/queryException/12', 'title' => ''], + 'ServiceIp' => ['description' => 'The IP address of the host where the application resides.'."\n", 'type' => 'string', 'example' => '172.20.XX.XX', 'title' => ''], + 'Duration' => ['description' => 'The amount of time consumed by the trace. Unit: milliseconds.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '679', 'title' => ''], + 'Timestamp' => ['description' => 'The timestamp.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1595174436994', 'title' => ''], + 'ServiceName' => ['description' => 'The name of the application.'."\n", 'type' => 'string', 'example' => 'arms-k8s-demo-subcomponent', 'title' => ''], + 'TraceID' => ['description' => 'The trace ID.'."\n", 'type' => 'string', 'example' => 'ac1400a115951744369947025d****', 'title' => ''], + 'SpanID' => ['description' => 'The span ID of the trace.'."\n", 'type' => 'string', 'example' => 'be3d6dcf5750e***', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"AlertIMRobots\\": [\\n {\\n \\"RobotId\\": 123,\\n \\"Type\\": \\"dingding\\",\\n \\"RobotName\\": \\"robot名称\\",\\n \\"RobotAddr\\": \\"https://oapi.dingtalk.com/robot/send?access_token=e1a049121******\\",\\n \\"DailyNoc\\": true,\\n \\"DailyNocTime\\": \\"09:30,17:30\\",\\n \\"DingSignKey\\": \\"******\\",\\n \\"CreateTime\\": \\"2023-01-16 17:21:48\\",\\n \\"DispatchRules\\": [\\n {\\n \\"id\\": 12345,\\n \\"name\\": \\"通知策略测试\\"\\n }\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeIMRobotsResponse>\\n <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <AlertIMRobots>\\n <RobotId>123</RobotId>\\n <Type>dingding</Type>\\n <RobotName>robot名称</RobotName>\\n <RobotAddr>https://oapi.dingtalk.com/robot/send?access_token=e1a049121******</RobotAddr>\\n <DailyNoc>true</DailyNoc>\\n <DailyNocTime>09:30,17:30</DailyNocTime>\\n </AlertIMRobots>\\n </PageBean>\\n</DescribeIMRobotsResponse>","errorExample":""}]', - 'title' => 'DescribeIMRobots', - ], - 'CreateOrUpdateWebhookContact' => [ - 'summary' => 'Creates or modifies a webhook alert contact.', - 'methods' => [ - 'get', - 'post', + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 5,\\n \\"Total\\": 1601,\\n \\"TraceInfos\\": [\\n {\\n \\"OperationName\\": \\"/demo/queryException/12\\",\\n \\"ServiceIp\\": \\"172.20.XX.XX\\",\\n \\"Duration\\": 679,\\n \\"Timestamp\\": 1595174436994,\\n \\"ServiceName\\": \\"arms-k8s-demo-subcomponent\\",\\n \\"TraceID\\": \\"ac1400a115951744369947025d****\\",\\n \\"SpanID\\": \\"be3d6dcf5750e***\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchTracesByPageResponse>\\n <RequestId>4C518054-852F-4023-ABC1-4AF95FF7****</RequestId>\\n <PageBean>\\n <PageNumber>1</PageNumber>\\n <PageSize>5</PageSize>\\n <Total>1601</Total>\\n <TraceInfos>\\n <OperationName>/demo/queryException/12</OperationName>\\n <ServiceIp>172.20.XX.XX</ServiceIp>\\n <Duration>679</Duration>\\n <Timestamp>1595174436994</Timestamp>\\n <ServiceName>arms-k8s-demo-subcomponent</ServiceName>\\n <TraceID>ac1400a115951744369947025d****</TraceID>\\n </TraceInfos>\\n </PageBean>\\n</SearchTracesByPageResponse>","errorExample":""}]', + 'title' => 'SearchTracesByPage', + 'summary' => 'Queries traces by page. You can query traces by time range, application name, IP address, span name, or tag.', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-10-08T03:39:44.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-14T01:52:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-04T03:35:55.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchTracesByPage'], + ], ], + 'ramActions' => [], + ], + 'SendTTSVerifyLink' => [ + 'summary' => 'Sends a text message to an alert contact to verify the mobile number of the alert contact.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -39999,200 +27833,117 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'WebhookId', + 'name' => 'ContactId', 'in' => 'formData', - 'schema' => [ - 'title' => '告警webhook ID', - 'description' => 'The ID of the webhook alert contact.'."\n" - ."\n" - .'* If you do not specify this parameter, a new webhook alert contact is created.'."\n" - .'* If you specify this parameter, the specified webhook alert contact is modified.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['title' => '', 'description' => 'The ID of the alert contact.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '123'], ], [ - 'name' => 'WebhookName', + 'name' => 'Phone', 'in' => 'formData', - 'schema' => [ - 'title' => '告警webhook名称', - 'description' => 'The name of the webhook alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Webhook alert'."\n", - ], + 'schema' => ['title' => '', 'description' => 'The mobile number of the alert contact.'."\n", 'type' => 'string', 'required' => true, 'example' => '1381111****'], ], - [ - 'name' => 'Method', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => 'Http请求方法', - 'description' => 'The HTTP request method.'."\n" - ."\n" - .'* Post'."\n" - .'* Get'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'Post', + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****'], + 'IsSuccess' => ['description' => 'Indicates whether the text message was sent.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'example' => '', ], ], - [ - 'name' => 'Url', - 'in' => 'formData', - 'schema' => [ - 'title' => 'Url', - 'description' => 'The URL of the HTTP request **method**.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', - ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<SendTTSVerifyLinkResponse>\\n <RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</SendTTSVerifyLinkResponse>","errorExample":""}]', + 'title' => 'SendTTSVerifyLink', + 'description' => 'After you receive the text message, verify the mobile number as prompted. Before you can specify a mobile phone number in a notification policy, you must verify the mobile phone number.'."\n", + 'changeSet' => [ + ['createdAt' => '2022-01-06T13:24:53.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendTTSVerifyLink'], ], + ], + 'ramActions' => [], + ], + 'SetRetcodeShareStatus' => [ + 'summary' => 'Turns on or turns off logon-free sharing for an application monitored by Browser Monitoring.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'BizHeaders', - 'in' => 'formData', - 'schema' => [ - 'title' => 'http请求头', - 'description' => 'The HTTP request headers.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"Content-Type":"application/json;charset=utf-8"}]', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'BizParams', - 'in' => 'formData', - 'schema' => [ - 'title' => 'http请求参数', - 'description' => 'The parameters in the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"content":"mike"}]', - ], + 'name' => 'Pid', + 'in' => 'query', + 'schema' => ['description' => 'The process identifier (PID) of the application. '."\n" + ."\n" + .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the `pid=xxx` format. The PID is usually percent encoded as `xxx%40xxx`. You must modify this value to remove the percent encoding. For example, if the PID in the URL is `eb4zdose6v%409781be0f44d****`, you must replace `%40` with @ to obtain `eb4zdose6v@9781be0f44d****`.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'atc889zkcf@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'Body', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警通知模板', - 'description' => 'The notification template that is sent when an alert is triggered. This parameter is required if the **Method** parameter is set to **Post**. You can use the `$content` placeholder to specify the notification content. The content cannot exceed 500 characters in length. For more information, see [Variable description of a notification template](~~251834~~).\\\\'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Alert time":"{{ .startTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to turn on or turn off the logon-free sharing switch. Valid values:'."\n" + ."\n" + .'* `true`: Turn on the switch.'."\n" + .'* `false`: Turn off the switch.'."\n", 'type' => 'boolean', 'required' => true, 'docRequired' => true, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'RecoverBody', - 'in' => 'formData', - 'schema' => [ - 'title' => '告警恢复模板', - 'description' => 'The notification template that is sent when an alert is resolved. This parameter is required if the **Method** parameter is set to **Post**. You can use the `$content` placeholder to specify the notification content. The content cannot exceed 500 characters in length. For more information, see [Variable description of a notification template](~~251834~~).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Recovery time":"{{ .endTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], + 'name' => 'AppName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the application that is monitored by Browser Monitoring.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test-app', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - 'WebhookContact' => [ - 'description' => 'The returned webhook alert contact.'."\n", - 'type' => 'object', - 'properties' => [ - 'WebhookId' => [ - 'title' => '告警webhook ID', - 'description' => 'The ID of the webhook alert contact.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'WebhookName' => [ - 'title' => '告警webhook名称', - 'description' => 'The name of the webhook alert contact.'."\n", - 'type' => 'string', - 'example' => 'Webhook alert'."\n", - ], - 'Webhook' => [ - 'description' => 'The information about the webhook alert contact.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => 'Http请求方法', - 'description' => 'The HTTP request method.'."\n" - ."\n" - .'* Post'."\n" - .'* Get'."\n", - 'type' => 'string', - 'example' => 'Post', - ], - 'Url' => [ - 'title' => 'url', - 'description' => 'The URL of the request method.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', - ], - 'BizHeaders' => [ - 'title' => 'http请求头', - 'description' => 'The HTTP request headers.'."\n", - 'type' => 'string', - 'example' => '[{"Content-Type":"application/json;charset=utf-8"}]', - ], - 'BizParams' => [ - 'title' => 'http请求参数', - 'description' => 'The parameters in the HTTP request.'."\n", - 'type' => 'string', - 'example' => '[{"content":"mike"}]', - ], - 'Body' => [ - 'title' => '告警通知模板', - 'description' => 'The alert notification template.'."\n", - 'type' => 'string', - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Alert time":"{{ .startTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], - 'RecoverBody' => [ - 'title' => '告警恢复模板', - 'description' => 'The notification template for clearing alerts.'."\n", - 'type' => 'string', - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Recovery time":"{{ .endTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], - ], - ], - ], - ], + 'IsSuccess' => ['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', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"WebhookContact\\": {\\n \\"WebhookId\\": 123,\\n \\"WebhookName\\": \\"Webhook告警\\",\\n \\"Webhook\\": {\\n \\"Method\\": \\"Post\\",\\n \\"Url\\": \\"https://oapi.dingtalk.com/robot/send?access_token=e1a049121******\\",\\n \\"BizHeaders\\": \\"[{\\\\\\"Content-Type\\\\\\":\\\\\\"application/json;charset=utf-8\\\\\\"}]\\",\\n \\"BizParams\\": \\"[{\\\\\\"content\\\\\\":\\\\\\"mike\\\\\\"}]\\",\\n \\"Body\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"告警时间\\\\\\":\\\\\\"{{ .startTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\",\\n \\"RecoverBody\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"恢复时间\\\\\\":\\\\\\"{{ .endTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\"\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateWebhookContactResponse>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n <WebhookContact>\\n <WebhookId>123</WebhookId>\\n <WebhookName>Webhook告警</WebhookName>\\n <Webhook>\\n <Method>Post</Method>\\n <Url>https://oapi.dingtalk.com/robot/send?access_token=e1a049121******</Url>\\n <BizHeaders>[{\\"Content-Type\\":\\"application/json;charset=utf-8\\"}]</BizHeaders>\\n <BizParams>[{\\"content\\":\\"mike\\"}]</BizParams>\\n <Body>{ \\"告警名称\\":\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\", \\"集群名称\\":\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\", \\"应用名称\\":\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\", \\"通知策略\\":\\"{{ .dispatchRuleName }}\\", \\"告警时间\\":\\"{{ .startTime }}\\", \\"告警内容\\":\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\" }</Body>\\n <RecoverBody>{ \\"告警名称\\":\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\", \\"集群名称\\":\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\", \\"应用名称\\":\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\", \\"通知策略\\":\\"{{ .dispatchRuleName }}\\", \\"恢复时间\\":\\"{{ .endTime }}\\", \\"告警内容\\":\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\" }</RecoverBody>\\n </Webhook>\\n </WebhookContact>\\n</CreateOrUpdateWebhookContactResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateWebhookContact', - ], - 'DeleteWebhookContact' => [ - 'summary' => 'Deletes a webhook alert contact.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"40B10E04-81E8-4643-970D-F1B38F2E****\\"\\n}","errorExample":""},{"type":"xml","example":"<SetRetcodeShareStatusResponse>\\n <IsSuccess>true</IsSuccess>\\n <RequestId>40B10E04-81E8-4643-970D-F1B38F2E****</RequestId>\\n</SetRetcodeShareStatusResponse>","errorExample":""}]', + 'title' => 'SetRetcodeShareStatus', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2023-01-03T03:37:17.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StartAlert' => [ + 'summary' => 'Invoke the StartAlert API to start an alert rule. ', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -40200,349 +27951,318 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'WebhookId', + 'name' => 'AlertId', 'in' => 'query', - 'schema' => [ - 'title' => '告警webhookID', - 'description' => 'The ID of the webhook alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the alert rule. You can call the SearchAlertRules operation and view the `Id` parameter in the response. For more information, see [SearchAlertRules](~~175825~~).', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1610***', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-hangzhou`.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the webhook alert contact was deleted.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'IsSuccess' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteWebhookContactResponse>\\n <RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteWebhookContactResponse>","errorExample":""}]', - 'title' => 'DeleteWebhookContact', - ], - 'DescribeWebhookContacts' => [ - 'summary' => 'Queries the list of webhook alert contacts.', - 'methods' => [ - 'get', + 'title' => 'Start Alert Rule ', + 'description' => 'This API is no longer maintained. Use the AlertStatus parameter of the CreateOrUpdateAlertRule API in the new alert management system to update the running status of an alert rule. ', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-07-12T01:45:49.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:StartAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\"\\n}","type":"json"}]', + ], + 'StartTimingSyntheticTask' => [ + 'summary' => 'Starts scheduled synthetic monitoring tasks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '118619', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', - ], - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'WebhookName', + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'TaskIds', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'title' => '告警webhook名称', - 'description' => 'The name of the webhook alert contact.'."\n", - 'type' => 'string', + 'description' => 'The task IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The task IDs.'."\n", 'type' => 'string', 'required' => false, 'example' => '12312jejcc23dcewd', 'title' => ''], 'required' => false, - 'example' => 'Webhook name'."\n", + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Page', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => 'StartTimingSyntheticTask', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartTimingSyntheticTask'], + ], + ], + 'ramActions' => [], + ], + 'StopAlert' => [ + 'summary' => 'Call StartAlert to stop an alert rule.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'Size', + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ + [ + 'name' => 'AlertId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of alert contacts displayed on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1610***', 'title' => ''], ], [ - 'name' => 'ContactIds', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '123', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], - 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The returned objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of alert contacts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每一页数目', - 'description' => 'The number of alert contacts displayed on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'WebhookContacts' => [ - 'title' => '告警webhook联系人列表', - 'description' => 'The list of webhook alert contacts.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'WebhookId' => [ - 'title' => '告警webhookID', - 'description' => 'The ID of the webhook alert contact.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '123', - ], - 'WebhookName' => [ - 'title' => '告警webhook名称', - 'description' => 'The name of the webhook alert contact.'."\n", - 'type' => 'string', - 'example' => 'Webhook name'."\n", - ], - 'Webhook' => [ - 'title' => 'webhook对象', - 'description' => 'The details of the webhook alert contact.'."\n", - 'type' => 'object', - 'properties' => [ - 'Method' => [ - 'title' => 'http请求方式', - 'description' => 'The HTTP request method.'."\n" - ."\n" - .'* Get'."\n" - .'* Post'."\n", - 'type' => 'string', - 'example' => 'Post', - ], - 'Url' => [ - 'title' => 'Url', - 'description' => 'The URL of the request method.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', - ], - 'BizHeaders' => [ - 'title' => 'HTTP请求头', - 'description' => 'The header of the HTTP request.'."\n", - 'type' => 'object', - 'example' => '[{"Content-Type":"application/json"}]', - ], - 'BizParams' => [ - 'title' => 'HTTP请求参数', - 'description' => 'The parameters in the HTTP request.'."\n", - 'type' => 'object', - 'example' => '[{"content:"mike"}]', - ], - 'Body' => [ - 'title' => '告警通知模板', - 'description' => 'The alert notification template.'."\n", - 'type' => 'string', - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Alert time":"{{ .startTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], - 'RecoverBody' => [ - 'title' => '告警恢复模板', - 'description' => 'The notification template for clearing alerts.'."\n", - 'type' => 'string', - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Recovery time":"{{ .endTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], - ], - ], - ], - ], - ], - ], - ], + 'IsSuccess' => ['description' => 'Indicates whether the request is successful. Valid values:'."\n" + ."\n" + .'* `true`: The request is successful.'."\n" + .'* `false`: The request fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"WebhookContacts\\": [\\n {\\n \\"WebhookId\\": 123,\\n \\"WebhookName\\": \\"webhook名称\\",\\n \\"Webhook\\": {\\n \\"Method\\": \\"Post\\",\\n \\"Url\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f6****\\",\\n \\"BizHeaders\\": [\\n {\\n \\"Content-Type\\": \\"application/json\\"\\n }\\n ],\\n \\"BizParams\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Body\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"告警时间\\\\\\":\\\\\\"{{ .startTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\",\\n \\"RecoverBody\\": \\"{ \\\\\\"告警名称\\\\\\":\\\\\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\\\\\", \\\\\\"集群名称\\\\\\":\\\\\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\\\\\", \\\\\\"应用名称\\\\\\":\\\\\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\\\\\", \\\\\\"通知策略\\\\\\":\\\\\\"{{ .dispatchRuleName }}\\\\\\", \\\\\\"恢复时间\\\\\\":\\\\\\"{{ .endTime }}\\\\\\", \\\\\\"告警内容\\\\\\":\\\\\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\\\\\" }\\"\\n }\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeWebhookContactsResponse>\\n <RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <WebhookContacts>\\n <WebhookId>123</WebhookId>\\n <WebhookName>webhook名称</WebhookName>\\n <Webhook>\\n <Method>Post</Method>\\n <Url>https://oapi.dingtalk.com/robot/send?access_token=91f2f6****</Url>\\n <BizHeaders>[{\\"Content-Type\\":\\"application/json\\"}]</BizHeaders>\\n <BizParams>[{\\"content:\\"mike\\"}]</BizParams>\\n <Body>{ \\"告警名称\\":\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\", \\"集群名称\\":\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\", \\"应用名称\\":\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\", \\"通知策略\\":\\"{{ .dispatchRuleName }}\\", \\"告警时间\\":\\"{{ .startTime }}\\", \\"告警内容\\":\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\" }</Body>\\n <RecoverBody>{ \\"告警名称\\":\\"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}\\", \\"集群名称\\":\\"{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }}\\", \\"应用名称\\":\\"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}\\", \\"通知策略\\":\\"{{ .dispatchRuleName }}\\", \\"恢复时间\\":\\"{{ .endTime }}\\", \\"告警内容\\":\\"{{ for .alerts }} {{ .annotations.message }} {{ end }}\\" }</RecoverBody>\\n </Webhook>\\n </WebhookContacts>\\n </PageBean>\\n</DescribeWebhookContactsResponse>","errorExample":""}]', - 'title' => 'DescribeWebhookContacts', - ], - 'CreateOrUpdateEventBridgeIntegration' => [ - 'summary' => 'Creates or modifies an EventBridge integration that is used to push notifications.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopAlertResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>27E653FA-5958-45BE-8AA9-14D884DC****</RequestId>\\n</StopAlertResponse>","errorExample":""}]', + 'title' => 'StopAlert', + 'description' => '当前接口已不再维护，请使用新版告警管理CreateOrUpdateAlertRule接口的AlertStatus参数更新告警规则运行状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-07-12T01:45:49.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'StopTimingSyntheticTask' => [ + 'summary' => 'Stops scheduled synthetic monitoring tasks.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the EventBridge integration.'."\n" - ."\n" - .'* If you do not specify this parameter, an EventBridge integration is created.'."\n" - .'* If you specify this parameter, the specified EventBridge integration is modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Name', - 'in' => 'formData', + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The name of the EventBridge integration.'."\n", - 'type' => 'string', + 'description' => 'The task IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'required' => false, 'example' => '3cee3d23ev4342342csc', 'title' => ''], 'required' => true, - 'example' => 'EventBridge_Test', - ], - ], - [ - 'name' => 'Description', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The description of the EventBridge integration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'test', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'Endpoint', - 'in' => 'formData', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'The public endpoint of EventBridge.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'http://xxxxx', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], - [ - 'name' => 'AccessKey', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The AccessKey ID that is used to connect to EventBridge.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc******************', - ], + ], + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], ], - [ - 'name' => 'AccessSecret', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The AccessKey secret that is used to connect to EventBridge.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'abc******************', - ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'INNER_PROHIBIT', 'errorMessage' => '内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'StopTimingSyntheticTask', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'changeSet' => [ + ['createdAt' => '2023-12-06T09:06:44.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTimingSyntheticTask'], ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'SwitchSyntheticTaskStatus' => [ + 'summary' => 'Starts or stops a scheduled synthetic monitoring task.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'EventBusName', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The name of the event bus.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EventBus_Test', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'none'], + 'parameters' => [ [ - 'name' => 'Source', - 'in' => 'formData', + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The event source.'."\n", - 'type' => 'string', + 'description' => 'The task IDs. You can specify up to 30 task IDs at a time.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '16720', 'title' => ''], 'required' => false, - 'example' => 'arms', + 'maxItems' => 30, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'EventBusRegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The region ID of the event bus.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'name' => 'SwitchStatus', + 'in' => 'query', + 'schema' => ['description' => 'Specifies whether to start or stop the task. Valid values:'."\n" + ."\n" + .'* **0**: stops the task'."\n" + .'* **1**: starts the task'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '0', 'title' => ''], ], ], 'responses' => [ @@ -40552,837 +28272,322 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2B289756-E791-5842-BCBD-AD414C******', - ], - 'EventBridgeIntegration' => [ - 'description' => 'The information about the EventBridge integration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the EventBridge integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Name' => [ - 'description' => 'The name of the EventBridge integration.'."\n", - 'type' => 'string', - 'example' => 'EventBridge_Test', - ], - 'Description' => [ - 'description' => 'The description of the EventBridge integration.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Endpoint' => [ - 'description' => 'The public endpoint of EventBridge.'."\n", - 'type' => 'string', - 'example' => 'http://xxxxx', - ], - 'AccessKey' => [ - 'description' => 'The AccessKey ID that is used to connect to EventBridge.'."\n", - 'type' => 'string', - 'example' => 'abc******************', - ], - 'AccessSecret' => [ - 'description' => 'The AccessKey secret that is used to connect to EventBridge.'."\n", - 'type' => 'string', - 'example' => 'abc******************', - ], - 'EventBusName' => [ - 'description' => 'The name of the event bus.'."\n", - 'type' => 'string', - 'example' => 'EventBus_Test', - ], - 'Source' => [ - 'description' => 'The event source.'."\n", - 'type' => 'string', - 'example' => 'arms', - ], - 'EventBusRegionId' => [ - 'description' => 'The region ID of the event bus.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Result' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B289756-E791-5842-BCBD-AD414C******\\",\\n \\"EventBridgeIntegration\\": {\\n \\"Id\\": 123,\\n \\"Name\\": \\"EventBridge_Test\\",\\n \\"Description\\": \\"test\\",\\n \\"Endpoint\\": \\"http://xxxxx\\",\\n \\"AccessKey\\": \\"abc******************\\",\\n \\"AccessSecret\\": \\"abc******************\\",\\n \\"EventBusName\\": \\"EventBus_Test\\",\\n \\"Source\\": \\"arms\\",\\n \\"EventBusRegionId\\": \\"cn-hangzhou\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateEventBridgeIntegrationResponse>\\n <RequestId>2B289756-E791-5842-BCBD-AD414C******</RequestId>\\n <EventBridgeIntegration>\\n <Id>123</Id>\\n <Name>EventBridge_Test</Name>\\n <Description>test</Description>\\n <Endpoint>http://xxxxx</Endpoint>\\n <AccessKey>abc******************</AccessKey>\\n <AccessSecret>abc******************</AccessSecret>\\n <EventBusName>EventBus_Test</EventBusName>\\n <Source>arms</Source>\\n <EventBusRegionId>cn-hangzhou</EventBusRegionId>\\n </EventBridgeIntegration>\\n</CreateOrUpdateEventBridgeIntegrationResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateEventBridgeIntegration', - ], - 'DeleteEventBridgeIntegration' => [ - 'summary' => 'Deletes an EventBridge integration that is used to push notifications.', - 'methods' => [ - 'post', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', + 'title' => 'SwitchSyntheticTaskStatus', + 'changeSet' => [ + ['createdAt' => '2022-08-25T11:32:27.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchSyntheticTaskStatus'], + ], ], + 'ramActions' => [], + ], + 'SyncRecordingRules' => [ + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '133880', - 'abilityTreeNodes' => [ - 'FEATUREarmsR0R9WE', - ], - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'description' => 'Required. The ID of the EventBridge notification integration. You can call the **ListEventBridgeIntegrations** operation to query the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '123', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the source cluster whose rules are to be synchronized.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], + ], + [ + 'name' => 'TargetClusters', + 'in' => 'query', + 'schema' => ['description' => 'The IDs of the target clusters for batch synchronization.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "cn":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***" ], "us":[ "ce30f833bc4a04a56a06b070319***" ], "jp":[ ], "ap":[ ], "gov":[ ], "finance":[ ] }', 'title' => ''], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. This can be the same as the region ID of the source cluster.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2B289756-E791-5842-BCBD-AD414C******', - ], - 'IsSuccess' => [ - 'description' => 'Indicates whether the EventBridge integration is deleted.'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID, which is used to locate logs and troubleshoot issues.', 'type' => 'string', 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****'], + 'Data' => ['description' => 'The response struct.', 'type' => 'string', 'example' => '{ "data":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***", "ce30f833bc4a04a56a06b070319***" ], "message":"设置RecordingRule失败的clusterIds", "success":true }', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned with the result.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B289756-E791-5842-BCBD-AD414C******\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteEventBridgeIntegrationResponse>\\n <RequestId>2B289756-E791-5842-BCBD-AD414C******</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteEventBridgeIntegrationResponse>","errorExample":""}]', - 'title' => 'DeleteEventBridgeIntegration', - ], - 'ListEventBridgeIntegrations' => [ - 'summary' => 'Queries EventBridge integrations that are used to push notifications.', - 'methods' => [ - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'Batch synchronize aggregation rules of a cluster to other target clusters across all regions', + 'summary' => 'Batch synchronizes the aggregation rules of a cluster to other target clusters across all regions.', + 'requestParamsDescription' => 'Note: The **TargetClusters** parameter specifies the target clusters for batch synchronization. Pass the value strictly in the defined parameter format. The value is a JSON object in which each element is an array. You can add the corresponding cluster IDs to the appropriate array element. The following example shows the parameter format and the region that each element represents. Add the target cluster IDs to the array element of the corresponding region: { "cn":[], //China "eu":[], //Europe "us":[], //Americas "jp":[], //Japan "ap":[], //Asia Pacific "gov":[], //China Government Cloud "finance":[] //China Finance Cloud }', + 'responseParamsDescription' => 'Note: In the **Data** response element, if success is true, the call succeeded. Otherwise, the call failed. If the data content is not empty, some target clusters failed to be configured during this call. The failure may be related to the cluster itself or a network request timeout. Check and verify the cause on your own, or categorize the failed clusters and make the call again.', + 'changeSet' => [ + ['createdAt' => '2023-03-20T10:14:13.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-09-02T03:06:13.000Z', 'description' => 'OpenAPI offline'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncRecordingRules'], + ], ], + 'ramActions' => [ + [ + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SyncRecordingRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"{ \\\\\\"data\\\\\\":[ \\\\\\"c06ca68cd16f14f52bb07772eda***\\\\\\", \\\\\\"c33dd70a0ac184c1b879d807ab2***\\\\\\", \\\\\\"c384cf7e4dcb543e6ac8c7d4dd3***\\\\\\", \\\\\\"ce30f833bc4a04a56a06b070319***\\\\\\" ], \\\\\\"message\\\\\\":\\\\\\"设置RecordingRule失败的clusterIds\\\\\\", \\\\\\"success\\\\\\":true }\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'translator' => 'machine', + ], + 'TagResources' => [ + 'summary' => 'Adds tags to ARMS resources.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Page', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.', + 'type' => 'array', + 'items' => ['description' => 'The instance ID.', 'type' => 'string', 'required' => false, 'example' => 'uxqcr8b***', 'title' => ''], 'required' => true, - 'example' => '1', + 'maxItems' => 50, + 'minItems' => 1, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Size', + 'name' => 'Tag', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The tags to add to the resource. You can specify a maximum of 20 tags.', + 'type' => 'array', + 'items' => [ + 'description' => 'code!=""', + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.', 'type' => 'string', 'required' => false, 'example' => 'Key1', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'required' => false, 'example' => 'Test1', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => true, - 'example' => '15', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Name', + 'name' => 'ResourceType', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the EventBridge integration.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'EventBridge_Test', - ], + 'schema' => ['description' => 'The type of the ARMS resources for which you want to modify tags. Valid values:'."\n" + ."\n" + .'- WEB: Browser Monitoring'."\n" + ."\n" + .'- APPLICATION: Application Monitoring'."\n" + ."\n" + .'- PROMETHEUS: Managed Service for Prometheus'."\n" + ."\n" + .'- SYNTHETICTASK: Synthetic Monitoring'."\n" + ."\n" + .'- ALERTRULE: Application Monitoring alert rule'."\n" + ."\n" + .'- PROMETHEUSALERTRULE: Managed Service for Prometheus alert rule'."\n" + ."\n" + .'- XTRACEAPP: Managed Service for OpenTelemetry', 'type' => 'string', 'required' => true, 'example' => 'APPLICATION', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2B289756-E791-5842-BCBD-AD414C******', - ], - 'PageBean' => [ - 'description' => 'The information about EventBridge integrations that is returned on each page.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'description' => 'The total number of EventBridge integrations that are returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'description' => 'The number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'EventBridgeIntegrations' => [ - 'description' => 'The EventBridge integrations.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The description of the EventBridge integration.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the EventBridge integration.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Name' => [ - 'description' => 'The name of the EventBridge integration.'."\n", - 'type' => 'string', - 'example' => 'EventBridge_Test', - ], - 'Description' => [ - 'description' => 'The description of the EventBridge integration.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '05919CF2-B8A1-588D-B3DB-89B3********'], + 'Data' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2B289756-E791-5842-BCBD-AD414C******\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 15,\\n \\"EventBridgeIntegrations\\": [\\n {\\n \\"Id\\": 123,\\n \\"Name\\": \\"EventBridge_Test\\",\\n \\"Description\\": \\"test\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListEventBridgeIntegrationsResponse>\\n <RequestId>2B289756-E791-5842-BCBD-AD414CC212D2</RequestId>\\n <PageBean>\\n <Total>24</Total>\\n <Page>1</Page>\\n <Size>15</Size>\\n <EventBridgeIntegrations>\\n <Id>123</Id>\\n <Name>EventBridge_Test</Name>\\n <Description>EventBridge描述</Description>\\n </EventBridgeIntegrations>\\n </PageBean>\\n</ListEventBridgeIntegrationsResponse>","errorExample":""}]', - 'title' => 'ListEventBridgeIntegrations', - ], - 'CreateOrUpdateNotificationPolicy' => [ - 'summary' => 'Creates or modifies a notification policy.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'NoPermissionKeyOperator', 'errorMessage' => 'user is no permission for operating param tagKey.', 'description' => ''], + ['errorCode' => 'ResourceIdAndTagIsNull', 'errorMessage' => 'resourceId or tag param must have one', 'description' => ''], + ['errorCode' => 'TagISNull', 'errorMessage' => 'param tag must be not null.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'ResourceIdIsNull', 'errorMessage' => 'param resourceId must be not null.', 'description' => ''], + ['errorCode' => 'ResourceTypeIllegal', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => 'The specified ResourceType parameter is invalid.'], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ['errorCode' => 'ScopeDisAgreement', 'errorMessage' => 'Param scope is different from before.', 'description' => ''], + ['errorCode' => 'ParameterNextTokenIllegal', 'errorMessage' => 'param nextToken is invalid.', 'description' => ''], + ['errorCode' => 'InvalidParameterTagKey', 'errorMessage' => 'The specified TagKey is invalid.', 'description' => 'The specified TagKey parameter is invalid.'], + ['errorCode' => 'InvalidParameterTagValue', 'errorMessage' => 'The specified TagValue is invalid.', 'description' => 'The specified TagValue parameter is invalid.'], + ['errorCode' => 'TagKeyIsIllegal', 'errorMessage' => 'The specified TagKey is invalid.', 'description' => 'The specified TagKey parameter is invalid.'], + ['errorCode' => 'TagValueIsIllegal', 'errorMessage' => 'The specified TagValue is invalid.', 'description' => 'The specified TagValue parameter is invalid.'], + ['errorCode' => 'ResourceIDOUT', 'errorMessage' => 'The specified resourceId number is out of range.', 'description' => 'The number of resource IDs exceeds the upper limit.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'title' => 'TagResources', + 'changeSet' => [ + ['createdAt' => '2024-04-11T06:50:09.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-12T01:53:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-04-23T07:57:05.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-10T02:18:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-25T07:26:17.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05919CF2-B8A1-588D-B3DB-89B3********\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + ], + 'UninstallManagedPrometheus' => [ + 'summary' => 'Uninstalls a managed Prometheus agent for a serverless Kubernetes (ASK) cluster, Distributed Cloud Container Platform for Kubernetes (ACK One) cluster, or Elastic Compute Service (ECS) cluster.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, + 'deprecated' => true, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '119001', + 'abilityTreeNodes' => ['FEATUREarmsC7S24K'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '通知策略ID', - 'description' => 'The ID of the notification policy.'."\n" - ."\n" - .'* If you do not specify this parameter, a new notification policy is created.'."\n" - .'* If you specify this parameter, the specified notification policy is modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '通知策略名称', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'notificationpolicy_test', - ], - ], - [ - 'name' => 'MatchingRules', - 'in' => 'formData', - 'schema' => [ - 'title' => '事件匹配规则列表', - 'description' => 'The matching rules. Format:'."\n" - ."\n" - .' ['."\n" - .' {'."\n" - .' "matchingConditions": ['."\n" - .' { '."\n" - .' "value": "test", // The value of the matching condition. '."\n" - .' "key": "alertname", // The key of the matching condition. '."\n" - .' "operator": "eq" // The logical operator of the matching condition, including eq (equal to), neq (not equal to), in (contains), nin (does not contain), re (regular expression match), and nre (regular expression mismatch). '."\n" - .' }'."\n" - .' ]'."\n" - .' } '."\n" - .' ]'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[ { "matchingConditions": [ { "value": "test", "key": "alertname", "operator": "eq" } ] } ]', - ], + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'SendRecoverMessage', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否发送恢,不填默认为：true复通知', - 'description' => 'Specifies whether the status of an alert automatically changes to Resolved when all events related to the alert change to the Restored state. ARMS notifies contacts when the alert status changes to Resolved.'."\n" - ."\n" - .'* `true`: The system sends a notification.'."\n" - .'* `false`: The system does not send a notification.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the Container Service for Kubernetes (ACK) cluster. This parameter is required when the ClusterType parameter is set to ask or one.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****'], ], [ - 'name' => 'GroupRule', - 'in' => 'formData', - 'schema' => [ - 'title' => '分组规则', - 'description' => 'An array of alert event group objects.'."\n" - ."\n" - .'* If you do not specify the groupingFields field, all alerts will be sent to contacts based on `alertname`.'."\n" - .'* If you specify the groupingFields field, alerts with the same field will be sent to contacts in one notification.'."\n" - ."\n" - .'Sample statement:'."\n" - ."\n" - .' { '."\n" - .' "groupWait":5, // The waiting time for grouping. '."\n" - .' "groupInterval":30, // The time interval of grouping. '."\n" - .' "groupingFields":["alertname"] // The field that is used to group alert events. '."\n" - .' }'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "groupWait":5, "groupInterval":30, "groupingFields":["alertname"] }', - ], + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The ID of the resource group to which the Prometheus instance belongs.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****'], ], [ - 'name' => 'NotifyRule', - 'in' => 'formData', + 'name' => 'ClusterType', + 'in' => 'query', 'schema' => [ - 'title' => '通知规则,通知对象，必填', - 'description' => 'An array of notification rule objects. Format:'."\n" - ."\n" - .' { '."\n" - .' "notifyStartTime":"00:00", // The start time of the notification window. '."\n" - .' "notifyEndTime":"23:59", // The end time of the notification window. '."\n" - .' "notifyChannels":["dingTalk", "email", "sms", "tts", "webhook"], // The notification methods. Valid values: dingTalk, email, sms, tts, and webhook. '."\n" - .' "notifyObjects":[{ // An array of notification objects. '."\n" - .' "notifyObjectType":"CONTACT", // The type of the notification object. Valid values: CONTACT (contact), CONTACT_GROUP (contact group), ARMS_CONTACT (ARMS contact), ARMS_CONTACT_GROUP (ARMS contact group), DING_ROBOT_GROUP (DingTalk, Lark, WeCom, or IM robot), and CONTACT_SCHEDULE (user on duty defined by a schedule). '."\n" - .' "notifyObjectId":123, // The ID of the notification object. '."\n" - .' "notifyObjectName":"test" // The name of the notification object. '."\n" - .' }]'."\n", + 'title' => '', + 'description' => 'The cluster type. Valid values: ask, ecs, and one.'."\n", 'type' => 'string', 'required' => true, - 'example' => '{ "notifyStartTime":"00:00", "notifyEndTime":"23:59", "notifyChannels":[ "dingTalk", "email", "sms", "tts", "webhook" ], "notifyObjects":[ { "notifyObjectType":"CONTACT", "notifyObjectId":123, "notifyObjectName":"test" } ] }', - ], - ], - [ - 'name' => 'NotifyTemplate', - 'in' => 'formData', - 'schema' => [ - 'title' => '通知模板', - 'description' => 'The notification template. The default notification template is provided below the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '"robotContent":"{{if .commonLabels.clustername }} > Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} > Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{.annotations.message}} {{if .generatorURL }} \\[Link]\\({{.generatorURL}}) {{ end }} {{if eq "true" .labels.\\_aliyun_arms_is_denoise_filtered }} (Suspected noise) {{end}} {{end}}"'."\n", - ], - ], - [ - 'name' => 'EscalationPolicyId', - 'in' => 'formData', - 'schema' => [ - 'title' => '升级规则ID', - 'description' => 'The ID of the escalation policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '123', - ], - ], - [ - 'name' => 'Repeat', - 'in' => 'formData', - 'schema' => [ - 'title' => '是否重复通知,不填默认为true，需要必填重复通知时间间隔；false，需要必填升级规则ID', - 'description' => 'Specifies whether to resend a notification for a long-lasting unresolved alert. Default value: true. Valid values:'."\n" - ."\n" - .'* `true`: If you set this parameter to `true`, you must set **RepeatInterval**.'."\n" - .'* `false`: If you set this parameter to `false`, you must set **EscalationPolicyId**.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], - ], - [ - 'name' => 'RepeatInterval', - 'in' => 'formData', - 'schema' => [ - 'title' => '重复通知时间间隔,单位：s', - 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '600', - ], - ], - [ - 'name' => 'IntegrationId', - 'in' => 'formData', - 'schema' => [ - 'title' => '集成ID', - 'description' => 'The integration ID of the ticket system to which alerts are pushed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '34', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'DirectedMode', - 'in' => 'formData', - 'schema' => [ - 'title' => '极简模式', - 'description' => 'Specifies whether to enable simple mode.', - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', + 'docRequired' => true, + 'enumValueTitles' => ['ecs' => 'ecs', 'one' => 'one', 'ask' => 'ask'], + 'example' => 'ask', + 'enum' => ['ecs', 'ask', 'one', 'acs', 'flink'], ], ], [ - 'name' => 'State', - 'in' => 'formData', - 'schema' => [ - 'title' => '通知策略是否启用，enable 启用，disable 停用', - 'description' => 'Specifies whether to enable the notification policy. Valid values: enable and disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'enable', - ], + 'name' => 'VpcId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The ID of the virtual private cloud (VPC) where the cluster resides.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-rpn**********', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response object.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'NotificationPolicy' => [ - 'title' => '通知策略对象', - 'description' => 'An array of notification policy objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '通知策略ID', - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'title' => '通知策略名称', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'notificationpolicy_test', - ], - 'MatchingRules' => [ - 'title' => '事件匹配规则列表', - 'description' => 'The matching rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MatchingConditions' => [ - 'description' => 'The matching conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '条件字段', - 'description' => 'The key of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'altertname', - ], - 'Value' => [ - 'title' => '条件字段值', - 'description' => 'The value of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Operator' => [ - 'title' => '对应关系', - 'description' => 'The logical operator of the matching condition. Valid values:'."\n" - ."\n" - .'* `eq`: equal to'."\n" - .'* `neq`: not equal to'."\n" - .'* `in`: contains'."\n" - .'* `nin`: does not contain'."\n" - .'* `re`: regular expression match'."\n" - .'* `nre`: regular expression mismatch'."\n", - 'type' => 'string', - 'example' => 'eq', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'SendRecoverMessage' => [ - 'title' => '是否发送恢复通知', - 'description' => 'Indicates whether the status of an alert automatically changes to Resolved when all events related to the alert change to the Restored state. ARMS notifies contacts when the alert status changes to Resolved.'."\n" - ."\n" - .'* `true`: The system sends a notification.'."\n" - .'* `false`: The system does not send a notification.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'GroupRule' => [ - 'title' => '分组规则', - 'description' => 'An array of alert event group objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'GroupingFields' => [ - 'title' => '分组字段,为空则不分组，默认按照alertname分组', - 'description' => 'An array of alert event group objects.'."\n" - ."\n" - .'* If you do not specify the groupingFields field, all alerts will be sent to contacts based on `alertname`.'."\n" - .'* If you specify the groupingFields field, alerts with the same field will be sent to contacts in one notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The field that is used for grouping.'."\n", - 'type' => 'string', - 'example' => '["alertName","clustname"]', - ], - ], - 'GroupWait' => [ - 'title' => '分组等待时间，选填，默认是5秒', - 'description' => 'The waiting time for grouping. Unit: seconds. Default value: 5.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'GroupInterval' => [ - 'title' => '分组间隔时间，选填，默认是30s', - 'description' => 'The time interval of grouping. Unit: seconds. Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - ], - ], - 'NotifyRule' => [ - 'title' => '通知规则', - 'description' => 'An array of notification rule objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotifyStartTime' => [ - 'title' => '通知时间段开始时间', - 'description' => 'The start time of the notification window.'."\n", - 'type' => 'string', - 'example' => '00:00', - ], - 'NotifyEndTime' => [ - 'title' => '通知时间段结束时间', - 'description' => 'The end time of the notification window.'."\n", - 'type' => 'string', - 'example' => '23:59', - ], - 'NotifyChannels' => [ - 'title' => '通知渠道', - 'description' => 'The notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification methods. Valid values:'."\n" - ."\n" - .'* `dingTalk`: DingTalk'."\n" - .'* `email`: email'."\n" - .'* `sms`: text message'."\n" - .'* `tts`: phone call'."\n" - .'* `webhook`: webhook'."\n", - 'type' => 'string', - 'example' => '["dingTalk", "email", "sms", "tts", "webhook"]', - ], - ], - 'NotifyObjects' => [ - 'title' => '通知对象', - 'description' => 'An array of notification objects.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the notification object.'."\n", - 'type' => 'object', - 'properties' => [ - 'NotifyObjectType' => [ - 'title' => '通知对象类型，CONTACT, CONTACT_GROUP, ARMS_CONTACT, DING_ROBOT', - 'description' => 'The type of the notification object. Valid values:'."\n" - ."\n" - .'* CONTACT: contact'."\n" - .'* CONTACT_GROUP: contact group'."\n" - .'* ARMS_CONTACT: ARMS contact'."\n" - .'* ARMS_CONTACT_GROUP: ARMS contact group'."\n" - .'* DING_ROBOT_GROUP: DingTalk, Lark, WeCom, or IM robot'."\n" - .'* CONTACT_SCHEDULE: user on duty defined by a schedule'."\n", - 'type' => 'string', - 'example' => 'CONTACT', - ], - 'NotifyObjectId' => [ - 'title' => '通知对象ID', - 'description' => 'The ID of the notification object.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'NotifyObjectName' => [ - 'title' => '通知对象名称', - 'description' => 'The name of the notification object.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'NotifyChannels' => [ - 'title' => '通知对象为联系人时的联系方式', - 'description' => 'The notification methods specified for a contact.', - 'type' => 'array', - 'items' => [ - 'title' => '', - 'description' => 'The notification methods. Valid values:'."\n" - ."\n" - .'- email: email'."\n" - .'- sms: text message'."\n" - .'- tts: phone call', - 'type' => 'string', - 'example' => 'sms'."\n", - ], - ], - ], - ], - ], - ], - ], - 'NotifyTemplate' => [ - 'title' => '通知模板', - 'description' => 'The notification template.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmailTitle' => [ - 'title' => '邮件标题', - 'description' => 'The title of the alert notification sent through email.'."\n", - 'type' => 'string', - 'example' => '{{ .commonLabels.alertname }}', - ], - 'EmailContent' => [ - 'title' => '邮件内容', - 'description' => 'The content of the alert notification sent through email.'."\n", - 'type' => 'string', - 'example' => 'Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} \\<a href="{{.generatorURL}}" >Link\\</a> {{end}} {{end}}'."\n", - ], - 'EmailRecoverTitle' => [ - 'title' => '恢复告警邮件标题', - 'description' => 'The title of the alert resolution notification sent through email.'."\n", - 'type' => 'string', - 'example' => '{{ .commonLabels.alertname }}', - ], - 'EmailRecoverContent' => [ - 'title' => '恢复告警邮件内容', - 'description' => 'The content of the alert resolution notification sent through email.'."\n", - 'type' => 'string', - 'example' => 'Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} \\<a href="{{.generatorURL}}" >Link\\</a> {{end}} {{end}}'."\n", - ], - 'SmsContent' => [ - 'title' => '短信内容', - 'description' => 'The content of the alert notification sent through text message.'."\n", - 'type' => 'string', - 'example' => '\\<SmsContent>Notification on the occurrence of a {{ .level }} alert. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</SmsContent>'."\n", - ], - 'SmsRecoverContent' => [ - 'title' => '恢复告警短信内容', - 'description' => 'The content of the alert resolution notification sent through text message.'."\n", - 'type' => 'string', - 'example' => '\\<SmsRecoverContent>Alert resolution notification. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</SmsRecoverContent>'."\n", - ], - 'TtsContent' => [ - 'title' => '智能语音告警内容', - 'description' => 'The content of the alert notification by phone.'."\n", - 'type' => 'string', - 'example' => '\\<TtsContent>Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</TtsContent>'."\n", - ], - 'TtsRecoverContent' => [ - 'title' => '智能语音恢复告警内容', - 'description' => 'The content of the alert resolution notification by phone.'."\n", - 'type' => 'string', - 'example' => '\\<TtsRecoverContent>Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</TtsRecoverContent>'."\n", - ], - 'RobotContent' => [ - 'title' => '机器人告警内容', - 'description' => 'The content of the alert notification sent by the IM robot.'."\n", - 'type' => 'string', - 'example' => '{{if .commonLabels.clustername }} > Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} > Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }}> {{.annotations.message}} {{if .generatorURL }} \\[Link]\\({{.generatorURL}}) {{ end }} {{if eq "true" .labels.\\_aliyun_arms_is_denoise_filtered }} (Suspected noise) {{end}} {{end}}'."\n", - ], - ], - ], - 'EscalationPolicyId' => [ - 'title' => '升级规则ID', - 'description' => 'The ID of the escalation policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Repeat' => [ - 'title' => '是否重复通知', - 'description' => 'Indicates whether a notification is resent for a long-lasting unresolved alert. Default value: true. Valid values:'."\n" - ."\n" - .'* `true`: The system resends a notification for a long-lasting unresolved alert at a specified time interval.'."\n" - .'* `false`: The system sends a notification for a long-lasting unresolved alert based on an escalation policy.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RepeatInterval' => [ - 'title' => '重复通知时间间隔', - 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '600', - ], - 'IntegrationId' => [ - 'title' => '集成ID', - 'description' => 'The integration ID of the ticket system to which alerts are pushed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'DirectedMode' => [ - 'title' => '极简模式', - 'description' => 'Specifies whether to enable simple mode.', - 'type' => 'boolean', - 'example' => 'false', - ], - 'State' => [ - 'title' => '通知策略是否启用，enable 启用，disable 停用', - 'description' => 'Indicates whether the notification policy is enabled. Valid values: enable and disable.', - 'type' => 'string', - 'example' => 'enable', - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Data' => ['description' => 'The response content. The status of the Prometheus instance is returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the Prometheus instance was removed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned if the request fails.'."\n", 'type' => 'string', 'example' => 'vpcId is blank', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. If another status code is returned, the request failed.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"NotificationPolicy\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"notificationpolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"SendRecoverMessage\\": true,\\n \\"GroupRule\\": {\\n \\"GroupingFields\\": [\\n \\"[\\\\\\"alertName\\\\\\",\\\\\\"clustname\\\\\\"]\\"\\n ],\\n \\"GroupWait\\": 5,\\n \\"GroupInterval\\": 30\\n },\\n \\"NotifyRule\\": {\\n \\"NotifyStartTime\\": \\"00:00\\",\\n \\"NotifyEndTime\\": \\"23:59\\",\\n \\"NotifyChannels\\": [\\n \\"[\\\\\\"dingTalk\\\\\\", \\\\\\"email\\\\\\", \\\\\\"sms\\\\\\", \\\\\\"tts\\\\\\", \\\\\\"webhook\\\\\\"]\\"\\n ],\\n \\"NotifyObjects\\": [\\n {\\n \\"NotifyObjectType\\": \\"CONTACT\\",\\n \\"NotifyObjectId\\": 123,\\n \\"NotifyObjectName\\": \\"test\\",\\n \\"NotifyChannels\\": [\\n \\"sms\\"\\n ]\\n }\\n ]\\n },\\n \\"NotifyTemplate\\": {\\n \\"EmailTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"EmailRecoverTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"SmsContent\\": \\"发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"SmsRecoverContent\\": \\"告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"RobotContent\\": \\"{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq \\\\\\"true\\\\\\" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}\\"\\n },\\n \\"EscalationPolicyId\\": 123,\\n \\"Repeat\\": true,\\n \\"RepeatInterval\\": 600,\\n \\"IntegrationId\\": 34,\\n \\"DirectedMode\\": true,\\n \\"State\\": \\"enable\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateNotificationPolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <NotificationPolicy>\\n <Id>1234</Id>\\n <Name>notificationpolicy_test</Name>\\n <MatchingRules>\\n <MatchingConditions>\\n <Key>altertname</Key>\\n <Value>test</Value>\\n <Operator>eq</Operator>\\n </MatchingConditions>\\n </MatchingRules>\\n <SendRecoverMessage>true</SendRecoverMessage>\\n <GroupRule>\\n <GroupingFields>[\\"alertName\\",\\"clustname\\"]</GroupingFields>\\n <GroupWait>5</GroupWait>\\n <GroupInterval>30</GroupInterval>\\n </GroupRule>\\n <NotifyRule>\\n <NotifyStartTime>00:00</NotifyStartTime>\\n <NotifyEndTime>23:59</NotifyEndTime>\\n <NotifyChannels>[\\"dingTalk\\", \\"email\\", \\"sms\\", \\"tts\\", \\"webhook\\"]</NotifyChannels>\\n <NotifyObjects>\\n <NotifyObjectType>CONTACT</NotifyObjectType>\\n <NotifyObjectId>123</NotifyObjectId>\\n <NotifyObjectName>test</NotifyObjectName>\\n </NotifyObjects>\\n </NotifyRule>\\n <NotifyTemplate>\\n <EmailTitle>{{ .commonLabels.alertname }}</EmailTitle>\\n <EmailContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\"{{.generatorURL}}\\" > 详情链接</a> {{ end }} {{ end }}</EmailContent>\\n <EmailRecoverTitle>{{ .commonLabels.alertname }}</EmailRecoverTitle>\\n <EmailRecoverContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\"{{.generatorURL}}\\" > 详情链接</a> {{ end }} {{ end }}</EmailRecoverContent>\\n <SmsContent>发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</SmsContent>\\n <SmsRecoverContent>告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</SmsRecoverContent>\\n <TtsContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</TtsContent>\\n <TtsRecoverContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</TtsRecoverContent>\\n <RobotContent>{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq \\"true\\" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}</RobotContent>\\n </NotifyTemplate>\\n <EscalationPolicyId>123</EscalationPolicyId>\\n <Repeat>true</Repeat>\\n <RepeatInterval>600</RepeatInterval>\\n <IntegrationId>34</IntegrationId>\\n </NotificationPolicy>\\n</CreateOrUpdateNotificationPolicyResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateNotificationPolicy', - 'requestParamsDescription' => '### Default notification template specified by the NotifyTemplate field'."\n" - ."\n" - .' {'."\n" - .' // An alert notification sent through email'."\n" - .' "emailTitle":"{{ .commonLabels.alertname }}",'."\n" - ."\n" - .' "emailContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} <a href="{{.generatorURL}}" >Link</a> {{ end }} {{ end }}",'."\n" - ."\n" - .' // An alert resolution notification sent through email'."\n" - .' "emailRecoverTitle":"{{ .commonLabels.alertname }}",'."\n" - ."\n" - .' "emailRecoverContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} <a href="{{.generatorURL}}" >Link</a> {{ end }} {{ end }}",'."\n" - ."\n" - .' // An alert notification sent through text message'."\n" - .' "smsContent":"Notification on the occurrence of a {{ .level }} alert. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}}}",'."\n" - ."\n" - .' // An alert resolution notification sent through text message'."\n" - .' "smsRecoverContent":"Alert resolution notification. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}",'."\n" - ."\n" - .' // An alert notification by phone'."\n" - .' "tsContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}",'."\n" - ."\n" - .' // An alert resolution notification by phone'."\n" - .' "ttsRecoverContent":"Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}",'."\n" - ."\n" - .' // An alert notification sent by the instant message (IM) robot'."\n" - .' "robotContent":"{{if .commonLabels.clustername }} > Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }} > Application name: {{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{.annotations.message}} {{if .generatorURL }} [Link]({{.generatorURL}}) {{ end }} {{if eq "true" .labels._aliyun_arms_is_denoise_filtered }} (Suspected noise) {{end}} {{end}}"'."\n" - ."\n" - .' }'."\n", - ], - 'DeleteNotificationPolicy' => [ - 'summary' => 'Deletes a notification policy based on its ID.', - 'methods' => [ - 'get', - 'post', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。'], + 'title' => 'UninstallManagedPrometheus', + 'description' => 'This operation is available only for ASK, ECS, and ACK One clusters. Before you call this operation, make sure that a managed Prometheus agent is installed for your cluster.'."\n", + 'changeSet' => [ + ['createdAt' => '2025-01-10T10:15:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-12-06T01:50:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-09-10T02:12:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-15T03:15:37.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-12-06T07:19:02.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-01-04T08:40:36.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-01-04T07:51:00.000Z', 'description' => 'OpenAPI offline'], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallManagedPrometheus'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Data\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"vpcId is blank\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'UninstallPromCluster' => [ + 'summary' => 'Releases a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41390,149 +28595,154 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'delete'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => '通知策略ID', - 'description' => 'The ID of the notification policy.'."\n" - ."\n" - .'For more information about how to obtain the ID of a notification policy, see [ListNotificationPolicies](~~2612375~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], + 'schema' => ['title' => '语言环境, 默认为中文 zh | en', 'description' => 'Language environment(If left blank, defaults to zh):'."\n" + .'- zh'."\n" + .'- en', 'type' => 'string', 'required' => false, 'example' => 'zh'], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => ['description' => 'The cluster ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The operation that you want to perform. Set the value to **DeleteNotificationPolicy**.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the notification policy.'."\n", + 'Data' => [ + 'description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'IsSuccess' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'boolean', - 'example' => 'true', + 'enumValueTitles' => [], + 'example' => 'success', + 'title' => '', ], + 'RequestId' => ['description' => 'The request ID. You can use the ID to find logs and troubleshoot issues.'."\n", 'type' => 'string', 'example' => '53980F48-DE82-53A1-9ADE-D2629226DD9A', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteNotificationPolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteNotificationPolicyResponse>","errorExample":""}]', - 'title' => 'DeleteNotificationPolicy', - ], - 'ListNotificationPolicies' => [ - 'summary' => 'Queries notification policies based on specified conditions.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"53980F48-DE82-53A1-9ADE-D2629226DD9A\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","errorExample":""},{"type":"xml","example":"<UninstallPromClusterResponse>\\n <Data>true</Data>\\n <RequestId>53980F48-DE82-53A1-9ADE-D2629226DD9A</RequestId>\\n</UninstallPromClusterResponse>","errorExample":""}]', + 'title' => 'UninstallPromCluster', + 'changeSet' => [ + ['createdAt' => '2023-11-16T11:13:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-09-29T11:40:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallPromCluster'], + ], ], + 'ramActions' => [], + ], + 'UntagResources' => [ + 'summary' => 'Removes tags from ARMS resources.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'TagKey', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '通知策略名称', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', + 'description' => 'The tag keys. You can specify a maximum of 20 tag keys.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The tag key.'."\n", 'type' => 'string', 'required' => false, 'example' => 'Key1', 'title' => ''], 'required' => false, - 'example' => 'notificationpolicy_test', - ], - ], - [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Size', + 'name' => 'ResourceId', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The instance ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c7c13c449eea64fe89870ac658d******', 'title' => ''], 'required' => true, - 'example' => '20', + 'maxItems' => 51, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'IsDetail', + 'name' => 'ResourceType', 'in' => 'query', 'schema' => [ - 'title' => '是否查询详情信息', - 'description' => 'Specifies whether to query the details about notification policies. Valid values:'."\n" + 'description' => 'The type of the ARMS resources for which you want to modify tags. Valid values:'."\n" ."\n" - .'* `true`: Details about notification policies are queried.'."\n" - .'* `false`: Details about notification policies are not queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'false', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Default value: **cn-hangzhou**.'."\n", + .'* WEB: Browser Monitoring'."\n" + .'* APPLICATION: Application Monitoring'."\n" + .'* PROMETHEUS: Managed Service for Prometheus'."\n" + .'* SYNTHETICTASK: Synthetic Monitoring'."\n" + .'* ALERTRULE: Application Monitoring alert rule'."\n" + .'* PROMETHEUSALERTRULE: Managed Service for Prometheus alert rule'."\n" + .'* XTRACEAPP: Managed Service for OpenTelemetry'."\n", 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'APPLICATION', + 'title' => '', ], ], [ - 'name' => 'Ids', + 'name' => 'All', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '12345', - ], + 'schema' => ['description' => 'Specifies whether to delete all tags. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n" + ."\n" + .'Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false', 'title' => ''], ], [ - 'name' => 'DirectedMode', + 'name' => 'Tags', 'in' => 'query', + 'style' => 'repeatList', 'schema' => [ - 'title' => '极简模式', - 'description' => 'Specifies whether to enable simple mode.', - 'type' => 'boolean', + 'description' => 'The list of tags.'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestTag', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], + ], + 'required' => false, + 'description' => '', + 'title' => '', + 'example' => '', + ], 'required' => false, - 'example' => 'true', + 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], @@ -41543,358 +28753,50 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The returned pages.', - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The number of notification policies that are returned.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '24', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The number of the page returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries that are returned on each page.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'NotificationPolicies' => [ - 'title' => '通知策略对象', - 'description' => 'The queried notification policies.', - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '通知策略ID', - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'title' => '通知策略名称', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'notificationpolicy_test', - ], - 'MatchingRules' => [ - 'title' => '事件匹配规则列表', - 'description' => 'The matching rules for alert events.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'MatchingConditions' => [ - 'title' => '匹配条件', - 'description' => 'The matching conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '条件字段', - 'description' => 'The key of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'altertname', - ], - 'Value' => [ - 'title' => '条件字段值', - 'description' => 'The value of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Operator' => [ - 'title' => '对应关系', - 'description' => 'The logical operator of the matching condition. Valid values:'."\n" - ."\n" - .'* `eq`: equal to'."\n" - .'* `neq`: not equal to'."\n" - .'* `in`: contains'."\n" - .'* `nin`: does not contain'."\n" - .'* `re`: regular expression match'."\n" - .'* `nre`: regular expression mismatch'."\n", - 'type' => 'string', - 'example' => 'eq', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', - ], - ], - 'SendRecoverMessage' => [ - 'title' => '是否发送恢复通知', - 'description' => 'Indicates whether the status of an alert automatically changes to Resolved when all events related to the alert change to the Restored state. The system sends a notification to the alert contacts when the alert status changes to Resolved.'."\n" - ."\n" - .'- `true` (default): The system sends a notification.'."\n" - .'- `false`: The system does not send a notification.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'GroupRule' => [ - 'title' => '分组规则', - 'description' => 'The grouping rule for alert events.', - 'type' => 'object', - 'properties' => [ - 'GroupingFields' => [ - 'title' => '分组字段,为空则不分组，默认按照alertname分组', - 'description' => 'An array of alert event group objects.'."\n" - ."\n" - .'* If you do not specify the groupingFields field, all alerts will be sent to contacts based on `alertname`.'."\n" - .'* If you specify the groupingFields field, alerts with the same field will be sent to contacts in one notification.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The field that is used for grouping.'."\n", - 'type' => 'string', - 'example' => '["alertname"]', - ], - ], - 'GroupWait' => [ - 'title' => '分组等待时间，选填，默认是5秒', - 'description' => 'The waiting time for grouping. Unit: seconds. Default value: 5.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '5', - ], - 'GroupInterval' => [ - 'title' => '分组间隔时间，选填，默认是30s', - 'description' => 'The time interval of grouping. Unit: seconds. Default value: 30.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '30', - ], - ], - ], - 'NotifyRule' => [ - 'title' => '通知规则', - 'description' => 'The notification rule.', - 'type' => 'object', - 'properties' => [ - 'NotifyStartTime' => [ - 'title' => '通知时间段开始时间', - 'description' => 'The start time of the notification window.'."\n", - 'type' => 'string', - 'example' => '00:00', - ], - 'NotifyEndTime' => [ - 'title' => '通知时间段结束时间', - 'description' => 'The end time of the notification window.'."\n", - 'type' => 'string', - 'example' => '23:59', - ], - 'NotifyChannels' => [ - 'title' => '通知渠道', - 'description' => 'The notification method.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The notification methods. Valid values:'."\n" - ."\n" - .'* `dingTalk`: DingTalk'."\n" - .'* `email`: email'."\n" - .'* `sms`: text message'."\n" - .'* `tts`: phone call'."\n" - .'* `webhook`: webhook'."\n", - 'type' => 'string', - 'example' => '[ "dingTalk", "email", "sms", "tts","webhook" ]', - ], - ], - 'NotifyObjects' => [ - 'title' => '通知对象', - 'description' => 'The notification objects.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotifyObjectType' => [ - 'title' => '通知对象类型，CONTACT, CONTACT_GROUP, ARMS_CONTACT, DING_ROBOT', - 'description' => 'The type of the notification object. Valid values:'."\n" - ."\n" - .'- CONTACT: an individual contact'."\n" - .'- CONTACT_GROUP: a contact group'."\n" - .'- DING_ROBOT: an instant messaging (IM) chatbot'."\n" - .'- CONTACT_SCHEDULE: a person on duty based on an established schedule', - 'type' => 'string', - 'example' => 'CONTACT', - ], - 'NotifyObjectId' => [ - 'title' => '通知对象ID', - 'description' => 'The ID of the notification object.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'NotifyObjectName' => [ - 'title' => '通知对象名称', - 'description' => 'The name of the notification object.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'NotifyChannels' => [ - 'title' => '通知对象为联系人时的联系方式', - 'description' => 'The notification methods specified for a contact.', - 'type' => 'array', - 'items' => [ - 'description' => 'The notification methods.'."\n" - ."\n" - .'- `email`: email'."\n" - .'- `sms`: text message'."\n" - .'- `tts`: phone call', - 'type' => 'string', - 'example' => '[ "email", "sms", "tts" ]', - ], - ], - ], - 'description' => '', - ], - ], - ], - ], - 'NotifyTemplate' => [ - 'title' => '通知模板', - 'description' => 'The notification template.'."\n", - 'type' => 'object', - 'properties' => [ - 'EmailTitle' => [ - 'title' => '邮件标题', - 'description' => 'The title of the alert notification sent by email.', - 'type' => 'string', - 'example' => '{{ .commonLabels.alertname }}', - ], - 'EmailContent' => [ - 'title' => '邮件内容', - 'description' => 'The content of the alert notification sent by email.', - 'type' => 'string', - 'example' => 'Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} \\<a href="{{.generatorURL}}" >Link\\</a> {{end}} {{end}}'."\n", - ], - 'EmailRecoverTitle' => [ - 'title' => '恢复告警邮件标题', - 'description' => 'The title of the alert resolution notification sent by email.', - 'type' => 'string', - 'example' => '{{ .commonLabels.alertname }}', - ], - 'EmailRecoverContent' => [ - 'title' => '恢复告警邮件内容', - 'description' => 'The content of the alert resolution notification sent by email.', - 'type' => 'string', - 'example' => 'Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{if .generatorURL }} \\<a href="{{.generatorURL}}" >Link\\</a> {{end}} {{end}}'."\n", - ], - 'SmsContent' => [ - 'title' => '短信内容', - 'description' => 'The content of the alert notification sent by text message.', - 'type' => 'string', - 'example' => '\\<SmsContent>Notification on the occurrence of a {{ .level }} alert. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</SmsContent>'."\n", - ], - 'SmsRecoverContent' => [ - 'title' => '恢复告警短信内容', - 'description' => 'The content of the alert resolution notification sent by text message.', - 'type' => 'string', - 'example' => '\\<SmsRecoverContent>Alert resolution notification. Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</SmsRecoverContent>'."\n", - ], - 'TtsContent' => [ - 'title' => '智能语音告警内容', - 'description' => 'The content of the alert notification sent by phone.', - 'type' => 'string', - 'example' => '\\<TtsContent>Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert time: {{ .startTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</TtsContent>'."\n", - ], - 'TtsRecoverContent' => [ - 'title' => '智能语音恢复告警内容', - 'description' => 'The content of the alert resolution notification sent by phone.', - 'type' => 'string', - 'example' => '\\<TtsRecoverContent>Alert name: {{ .commonLabels.alertname }}{{if .commonLabels.clustername }} Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }} Notification policy: {{ .dispatchRuleName }} Alert resolution time: {{ .endTime }} Alert content: {{ for .alerts }} {{.annotations.message}} {{ end }}\\</TtsRecoverContent>'."\n", - ], - 'RobotContent' => [ - 'title' => '机器人告警内容', - 'description' => 'The content of the alert notification sent by an IM chatbot.', - 'type' => 'string', - 'example' => '{{if .commonLabels.clustername }} > Cluster name: {{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }} > Application name: {{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }}> {{.annotations.message}} {{if .generatorURL }} \\[Link]\\({{.generatorURL}}) {{ end }} {{if eq "true" .labels.\\_aliyun_arms_is_denoise_filtered }} (Suspected noise) {{end}} {{end}}'."\n", - ], - ], - ], - 'Repeat' => [ - 'title' => '是否重复通知', - 'description' => 'Indicates whether the system resends notifications for a long-lasting unresolved alert. Valid values:'."\n" - ."\n" - .'- `true` (default): The system resends notifications for a long-lasting unresolved alert at a specified time interval.'."\n" - .'- `false`: The system resends notifications for a long-lasting unresolved alert based on an escalation policy.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'RepeatInterval' => [ - 'title' => '重复通知时间间隔', - 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '600', - ], - 'EscalationPolicyId' => [ - 'title' => '升级规则ID', - 'description' => 'The ID of the escalation policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'IntegrationId' => [ - 'title' => '集成ID', - 'description' => 'The integration ID of the ticket system to which alerts are pushed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '34', - ], - 'DirectedMode' => [ - 'title' => '极简模式', - 'description' => 'Indicates whether simple mode is enabled.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'State' => [ - 'title' => '通知策略是否启用，enable 启用，disable 停用', - 'description' => 'Indicates whether the notification policy is enabled. Valid values: enable and disable.', - 'type' => 'string', - 'example' => 'enable', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => 'FC183B5E-C9AD-5E9E-937F-*******'], + 'Data' => ['description' => 'The returned struct.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 24,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"NotificationPolicies\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"notificationpolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"SendRecoverMessage\\": true,\\n \\"GroupRule\\": {\\n \\"GroupingFields\\": [\\n \\"[\\\\\\"alertname\\\\\\"]\\"\\n ],\\n \\"GroupWait\\": 5,\\n \\"GroupInterval\\": 30\\n },\\n \\"NotifyRule\\": {\\n \\"NotifyStartTime\\": \\"00:00\\",\\n \\"NotifyEndTime\\": \\"23:59\\",\\n \\"NotifyChannels\\": [\\n \\"[ \\\\\\"dingTalk\\\\\\", \\\\\\"email\\\\\\", \\\\\\"sms\\\\\\", \\\\\\"tts\\\\\\",\\\\\\"webhook\\\\\\" ]\\"\\n ],\\n \\"NotifyObjects\\": [\\n {\\n \\"NotifyObjectType\\": \\"CONTACT\\",\\n \\"NotifyObjectId\\": 123,\\n \\"NotifyObjectName\\": \\"test\\",\\n \\"NotifyChannels\\": [\\n \\"[ \\\\\\"email\\\\\\", \\\\\\"sms\\\\\\", \\\\\\"tts\\\\\\" ]\\"\\n ]\\n }\\n ]\\n },\\n \\"NotifyTemplate\\": {\\n \\"EmailTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"EmailRecoverTitle\\": \\"{{ .commonLabels.alertname }}\\",\\n \\"EmailRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\\\\\"{{.generatorURL}}\\\\\\" > 详情链接</a> {{ end }} {{ end }}\\",\\n \\"SmsContent\\": \\"发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"SmsRecoverContent\\": \\"告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"TtsRecoverContent\\": \\"告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}\\",\\n \\"RobotContent\\": \\"{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\\\\\"app\\\\\\" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq \\\\\\"true\\\\\\" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}\\"\\n },\\n \\"Repeat\\": true,\\n \\"RepeatInterval\\": 600,\\n \\"EscalationPolicyId\\": 123,\\n \\"IntegrationId\\": 34,\\n \\"DirectedMode\\": true,\\n \\"State\\": \\"enable\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListNotificationPoliciesResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <PageBean>\\n <Total>24</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <NotificationPolicies>\\n <Id>1234</Id>\\n <Name>notificationpolicy_test</Name>\\n <MatchingRules>\\n <MatchingConditions>\\n <Key>altertname</Key>\\n <Value>test</Value>\\n <Operator>eq</Operator>\\n </MatchingConditions>\\n </MatchingRules>\\n <SendRecoverMessage>true</SendRecoverMessage>\\n <GroupRule>\\n <GroupingFields>[\\"alertname\\"]</GroupingFields>\\n <GroupWait>5</GroupWait>\\n <GroupInterval>30</GroupInterval>\\n </GroupRule>\\n <NotifyRule>\\n <NotifyStartTime>00:00</NotifyStartTime>\\n <NotifyEndTime>23:59</NotifyEndTime>\\n <NotifyChannels>[ \\"dingTalk\\", \\"email\\", \\"sms\\", \\"tts\\",\\"webhook\\" ]</NotifyChannels>\\n <NotifyObjects>\\n <NotifyObjectType>CONTACT</NotifyObjectType>\\n <NotifyObjectId>123</NotifyObjectId>\\n <NotifyObjectName>test</NotifyObjectName>\\n </NotifyObjects>\\n </NotifyRule>\\n <NotifyTemplate>\\n <EmailTitle>{{ .commonLabels.alertname }}</EmailTitle>\\n <EmailContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\"{{.generatorURL}}\\" > 详情链接</a> {{ end }} {{ end }}</EmailContent>\\n <EmailRecoverTitle>{{ .commonLabels.alertname }}</EmailRecoverTitle>\\n <EmailRecoverContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{if .generatorURL }} <a href=\\"{{.generatorURL}}\\" > 详情链接</a> {{ end }} {{ end }}</EmailRecoverContent>\\n <SmsContent>发生{{ .level }}告警 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</SmsContent>\\n <SmsRecoverContent>告警已经恢复 告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</SmsRecoverContent>\\n <TtsContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 告警时间：{{ .startTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</TtsContent>\\n <TtsRecoverContent>告警名称：{{ .commonLabels.alertname }}{{if .commonLabels.clustername }} 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }} 通知策略：{{ .dispatchRuleName }} 恢复时间：{{ .endTime }} 告警内容：{{ for .alerts }} {{ .annotations.message }} {{ end }}</TtsRecoverContent>\\n <RobotContent>{{if .commonLabels.clustername }} > 集群名称：{{ .commonLabels.clustername }} {{ end }}{{if eq \\"app\\" .commonLabels._aliyun_arms_involvedObject_kind }} > 应用名称：{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}{{ for .alerts }} > {{ .annotations.message }} {{if .generatorURL }} [详情链接]({{.generatorURL}}) {{end}} {{if eq \\"true\\" .labels._aliyun_arms_is_denoise_filtered }} （疑似噪音） {{end}} {{end}}</RobotContent>\\n </NotifyTemplate>\\n <Repeat>true</Repeat>\\n <RepeatInterval>600</RepeatInterval>\\n <EscalationPolicyId>123</EscalationPolicyId>\\n <IntegrationId>34</IntegrationId>\\n </NotificationPolicies>\\n </PageBean>\\n</ListNotificationPoliciesResponse>","errorExample":""}]', - 'title' => 'ListNotificationPolicies', - ], - 'CreateOrUpdateSilencePolicy' => [ - 'summary' => 'Creates or modifies a silence policy.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'NoPermissionKeyOperator', 'errorMessage' => 'user is no permission for operating param tagKey.', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ['errorCode' => 'ResourceIdAndTagIsNull', 'errorMessage' => 'resourceId or tag param must have one', 'description' => ''], + ['errorCode' => 'TagISNull', 'errorMessage' => 'param tag must be not null.', 'description' => ''], + ['errorCode' => 'ScopeDisAgreement', 'errorMessage' => 'Param scope is different from before.', 'description' => ''], + ['errorCode' => 'ParameterNextTokenIllegal', 'errorMessage' => 'param nextToken is invalid.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'ResourceTypeIllegal', 'errorMessage' => 'The ResourceType parameter is invalid.', 'description' => 'The specified ResourceType parameter is invalid.'], + ['errorCode' => 'ResourceIdIsNull', 'errorMessage' => 'param resourceId must be not null.', 'description' => ''], + ['errorCode' => 'InvalidParameterTagKey', 'errorMessage' => 'The specified TagKey is invalid.', 'description' => 'The specified TagKey parameter is invalid.'], + ['errorCode' => 'InvalidParameterTagValue', 'errorMessage' => 'The specified TagValue is invalid.', 'description' => 'The specified TagValue parameter is invalid.'], + ['errorCode' => 'TagKeyIsIllegal', 'errorMessage' => 'The specified TagKey is invalid.', 'description' => 'The specified TagKey parameter is invalid.'], + ['errorCode' => 'TagValueIsIllegal', 'errorMessage' => 'The specified TagValue is invalid.', 'description' => 'The specified TagValue parameter is invalid.'], + ['errorCode' => 'ResourceIDOUT', 'errorMessage' => 'The specified resourceId number is out of range.', 'description' => 'The number of resource IDs exceeds the upper limit.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC183B5E-C9AD-5E9E-937F-*******\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'UntagResources', + 'changeSet' => [ + ['createdAt' => '2023-06-25T02:25:54.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-05-12T01:53:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-03-10T02:18:10.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2022-03-25T07:26:17.000Z', 'description' => 'OpenAPI offline'], ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ], + ], + 'ramActions' => [], + ], + 'UpdateAlertContact' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -41902,241 +28804,88 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'formData', - 'schema' => [ - 'title' => '静默策略ID', - 'description' => 'The ID of the silence policy.'."\n" - ."\n" - .'* If you do not configure this parameter, a new silence policy is created.'."\n" - .'* If you configure this parameter, the specified silence policy is modified.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '1234', - ], - ], - [ - 'name' => 'Name', - 'in' => 'formData', - 'schema' => [ - 'title' => '静默策略名称', - 'description' => 'The name of the silence policy.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'silencepolicy_test', - ], + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => ['description' => 'The new name of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'John Doe', 'title' => ''], ], [ - 'name' => 'MatchingRules', - 'in' => 'formData', - 'schema' => [ - 'title' => '分派规则', - 'description' => 'The matching rules. The following code shows the format of matching rules:'."\n" - ."\n" - .' ['."\n" - .' {'."\n" - .' "matchingConditions": ['."\n" - .' {'."\n" - .' "value": "test", // The value of the matching condition. '."\n" - .' "key": "altertname", // The key of the matching condition. '."\n" - .' "operator": "eq" // The logical operator of the matching condition, including eq (equal to), neq (not equal to), in (contains), nin (does not contain), re (regular expression match), and nre (regular expression mismatch). '."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[ { "matchingConditions": [ { "value": "test", "key": "altertname", "operator": "eq" } ] } ]', - ], + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => ['description' => 'The new mobile phone number of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" + ."\n" + .'> If you do not specify this parameter, the original parameter value is deleted. If you specify this parameter, the original parameter value is updated.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '1381111****', 'title' => ''], ], [ - 'name' => 'RegionId', - 'in' => 'formData', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou'."\n", - ], + 'name' => 'Email', + 'in' => 'query', + 'schema' => ['description' => 'The new email address of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" + ."\n" + .'> If you do not specify this parameter, the original parameter value is deleted. If you specify this parameter, the original parameter value is updated.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'someone@example.com', 'title' => ''], ], [ - 'name' => 'State', - 'in' => 'formData', - 'schema' => [ - 'title' => '静默策略是否启用，enable 启用，disable 停用', - 'description' => 'Specifies whether to enable the silence policy. Valid values: enable and disable.', - 'type' => 'string', - 'required' => false, - 'example' => 'enable', - ], + 'name' => 'DingRobotWebhookUrl', + 'in' => 'query', + 'schema' => ['description' => 'The new webhook URL of the DingTalk chatbot. For more information, see [Configure a DingTalk chatbot to send alert notifications](~~106247~~). You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" + ."\n" + .'> If you do not specify this parameter, the original parameter value is deleted. If you specify this parameter, the original parameter value is updated.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', 'title' => ''], ], [ - 'name' => 'EffectiveTimeType', + 'name' => 'SystemNoc', 'in' => 'query', - 'allowEmptyValue' => false, - 'schema' => [ - 'description' => 'The effective duration of the silence policy. Valid values: PERMANENT, CUSTOM_TIME, and CYCLE_EFFECT.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'PERMANENT', - 'default' => 'PERMANENT', - 'enum' => [ - 'PERMANENT', - 'CYCLE_EFFECT', - 'CUSTOM_TIME', - ], - ], + 'schema' => ['description' => 'Specifies whether the alert contact receives system notifications. Valid values:'."\n" + ."\n" + .'* `true`: The alert contact receives system notifications.'."\n" + .'* `false`: The alert contact does not receive system notifications.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'TimePeriod', + 'name' => 'RegionId', 'in' => 'query', - 'allowEmptyValue' => true, - 'schema' => [ - 'description' => 'The recurring period. This parameter is required when EffectiveTimeType is set to CYCLE_EFFECT. DAY: The silence policy is effective by day. WEEK: The silence policy is effective by week.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'DAY', - 'enum' => [ - 'DAY', - 'WEEK', - ], - ], + 'schema' => ['description' => 'The ID of the region. Set the value to `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'TimeSlots', + 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => 'The time period during which the silence policy is effective. If you set EffectiveTimeType to CUSTOM_TIME, specify a custom time period in the following format: \\[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}] If you set EffectiveTimeType to CYCLE_EFFECT and TimePeriod to DAY, specify a custom time period in the following format: \\[{"startTime":"22:13","endTime":"22:21"}]. The start time cannot be later than the end time. If you set EffectiveTimeType to CYCLE_EFFECT and TimePeriod to WEEK, specify a custom time period in the following format: \\[{"startWeek":"1", "endWeek":"2" "startTime":"22:13","endTime":"22:21"}]. Valid values of startWeek and endWeek: 1 to 7. The start time cannot be later than the end time.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}]', - ], + 'schema' => ['description' => 'The ID of the alert contact to be updated. You can call the SearchAlertContact operation to query the contact ID. For more information, see [SearchAlertContact](~~130703~~).'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'SilencePolicy' => [ - 'title' => '静默策略对象', - 'description' => 'The silence policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '静默策略ID', - 'description' => 'The ID of the silence policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'title' => '静默策略名称', - 'description' => 'The name of the silence policy.'."\n", - 'type' => 'string', - 'example' => 'silencepolicy_test', - ], - 'MatchingRules' => [ - 'title' => '分派规则', - 'description' => 'A list of matching rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The matching rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'MatchingConditions' => [ - 'title' => '分派条件', - 'description' => 'A list of matching conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The matching condition.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '条件字段', - 'description' => 'The key of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'altertname', - ], - 'Value' => [ - 'title' => '条件字段值', - 'description' => 'The value of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Operator' => [ - 'title' => '对应关系', - 'description' => 'The logical operator of the matching condition. Valid values:'."\n" - ."\n" - .'* `eq`: equal to'."\n" - .'* `neq`: not equal to'."\n" - .'* `in`: contains'."\n" - .'* `nin`: does not contain'."\n" - .'* `re`: regular expression match'."\n" - .'* `nre`: regular expression mismatch'."\n", - 'type' => 'string', - 'example' => 'eq', - ], - ], - ], - ], - ], - ], - ], - 'State' => [ - 'title' => '静默策略是否启用，enable 启用，disable 停用', - 'description' => 'Specifies whether to enable the silence policy. Valid values: enable and disable.', - 'type' => 'string', - 'example' => 'enable', - ], - 'EffectiveTimeType' => [ - 'description' => 'The effective type. Valid values: PERMANENT: The policy is effective permanently. CYCLE_EFFECT: The policy is effective cyclically. CUSTOM_TIME: The policy is effective during a custom time period.'."\n", - 'type' => 'string', - 'example' => 'PERMANENT', - ], - 'TimePeriod' => [ - 'description' => 'Effective period. Valid values: DAY: daily WEEK: weekly'."\n", - 'type' => 'string', - 'example' => 'WEEK', - ], - 'TimeSlots' => [ - 'description' => 'The time period during which the silence policy is effective.'."\n", - 'type' => 'string', - 'example' => '[{startWeek: "1", startTime: "00:00", endTime: "11:59", endWeek:"7"}]'."\n", - ], - ], - ], + 'IsSuccess' => ['description' => 'Indicates whether the alert contact was updated. Valid values:'."\n" + ."\n" + .'* true: The alert contact was updated.'."\n" + .'* false: The alert contact failed to be updated.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"SilencePolicy\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"silencepolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"State\\": \\"enable\\",\\n \\"EffectiveTimeType\\": \\"PERMANENT\\",\\n \\"TimePeriod\\": \\"WEEK\\",\\n \\"TimeSlots\\": \\"[{startWeek: \\\\\\"1\\\\\\", startTime: \\\\\\"00:00\\\\\\", endTime: \\\\\\"11:59\\\\\\", endWeek:\\\\\\"7\\\\\\"}]\\\\n\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<CreateOrUpdateSilencePolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <SilencePolicy>\\n <Id>1234</Id>\\n <Name>silencepolicy_test</Name>\\n <MatchingRules>\\n <MatchingConditions>\\n <Key>altertname</Key>\\n <Value>test</Value>\\n <Operator>eq</Operator>\\n </MatchingConditions>\\n </MatchingRules>\\n </SilencePolicy>\\n</CreateOrUpdateSilencePolicyResponse>","errorExample":""}]', - 'title' => 'CreateOrUpdateSilencePolicy', - ], - 'DeleteSilencePolicy' => [ - 'summary' => 'Deletes a silence policy based on its ID.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlertContactResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>1A474FF8-7861-4D00-81B5-5BC3DA4E****</RequestId>\\n</UpdateAlertContactResponse>","errorExample":""}]', + 'title' => 'UpdateAlertContact', + 'summary' => 'Updates an alert contact.', + 'description' => 'This operation is no longer maintained. To create or modify an alert contact, call the CreateOrUpdateContact operation provided by the new version of Alert Management.'."\n", + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-14T01:30:42.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateAlertContactGroup' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -42144,673 +28893,311 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Id', + 'name' => 'ContactGroupName', 'in' => 'query', - 'schema' => [ - 'title' => '静默策略ID', - 'description' => 'The ID of the silence policy.'."\n" - ."\n" - .'For more information about how to obtain the ID of a silence policy, see [ListSilencePolicies](~~2612383~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The operation that you want to perform. Set the value to **DeleteSilencePolicy**.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - 'IsSuccess' => [ - 'title' => '删除静默策略是否成功', - 'description' => 'Indicates whether the silence policy was deleted successfully. Valid values:'."\n" - ."\n" - .'* `true`: The silence policy was deleted successfully.'."\n" - .'* `false`: The silence policy failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], + 'schema' => ['description' => 'The name of the alert contact group.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'TestGroup', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"IsSuccess\\": true\\n}","errorExample":""},{"type":"xml","example":"<DeleteSilencePolicyResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <IsSuccess>true</IsSuccess>\\n</DeleteSilencePolicyResponse>","errorExample":""}]', - 'title' => 'DeleteSilencePolicy', - ], - 'ListEscalationPolicies' => [ - 'summary' => 'Queries the information about an escalation policy.', - 'methods' => [ - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'Name', + 'name' => 'ContactIds', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the escalation policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'prod escalation policy'."\n", - ], + 'schema' => ['description' => 'The ID of the alert contact.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '123 234 345', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'ContactGroupId', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The ID of the alert contact group.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '123', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The returned objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'EscalationPolicies' => [ - 'description' => 'The list of escalation policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the escalation policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the escalation policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'description' => 'The name of the escalation policy.'."\n", - 'type' => 'string', - 'example' => 'prod escalation policy'."\n", - ], - ], - ], - ], - ], - ], + 'IsSuccess' => ['description' => 'Indicates whether the call was successful.'."\n" + ."\n" + .'* `true`: The call was successful.'."\n" + .'* `false`: The call failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"EscalationPolicies\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"prod升级策略\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListEscalationPoliciesResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <PageBean>\\n <Total>24</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <EscalationPolicies>\\n <Id>1234</Id>\\n <Name>prod升级策略</Name>\\n </EscalationPolicies>\\n </PageBean>\\n</ListEscalationPoliciesResponse>","errorExample":""}]', - 'title' => 'ListEscalationPolicies', - ], - 'ListOnCallSchedules' => [ - 'summary' => 'Queries the information about a scheduling policy.', - 'methods' => [ - 'get', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlertContactGroupResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>9319A57D-2D9E-472A-B69B-CF3CD16D****</RequestId>\\n</UpdateAlertContactGroupResponse>","errorExample":""}]', + 'title' => 'UpdateAlertContactGroup', + 'summary' => 'Updates UpdateAlertContactGroup alarm contact group.', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateContactGroup接口创建或修改告警联系人组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2022-03-17T03:38:04.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateAlertRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '排班策略名称', - 'description' => 'The name of the scheduling policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'OnCallSchedule_test', - ], + 'schema' => ['description' => 'The ID of the region.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'ContactGroupIds', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The IDs of the alert contact groups. The value must be a JSON array.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[123, 234]'."\n", 'title' => ''], ], [ - 'name' => 'Size', + 'name' => 'IsAutoStart', 'in' => 'query', - 'schema' => [ - 'title' => '展示数目', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'Specifies whether to enable the alert rule after it is created. Default value: `false`.'."\n" + ."\n" + .'* `true`: enables the alert rule.'."\n" + .'* `false`: disables the alert rule.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true', 'title' => ''], + ], + [ + 'name' => 'TemplageAlertConfig', + 'in' => 'query', + 'schema' => ['description' => 'The configurations of the alert template based on which you want to create an alert rule. The value must be a JSON string. You must set at least one of the **TemplateAlertId** and **TemplageAlertConfig** parameters. If you set both parameters, the **TemplateAlertId** parameter prevails. For more information about the TemplageAlertConfig parameter, see the following **additional information about the TemplageAlertConfig parameter**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '[ { "contactGroupIds": "381", "alertType": 5, "alarmContext": { "subTitle": "", "content": "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！" }, "alertLevel": "WARN", "metricParam": { "appId": "70901", "pid": "atc889zkcf@d8deedfa9bf****", "type": "TXN", "dimensions": [ { "type": "STATIC", "value": "\\\\/hello_test_api_address\\\\/test1", "key": "rpc" } ] }, "alertWay": [ "SMS", "MAIL", "DING_ROBOT" ], "alertRule": { "rules": [ { "measure": "appstat.txn.rt", "alias": "入口调用响应时间_ms", "aggregates": "AVG", "nValue": 1, "value": 1, "operator": "CURRENT_GTE" } ], "operator": "|" }, "title": "报警模板报警名", "config": "{\\"continuous\\":false,\\"dataRevision\\":2,\\"ownerId\\":\\"123412341234\\"}", "notice": { "noticeStartTime": 1480521600000, "startTime": 1480521600000, "endTime": 1480607940000, "noticeEndTime": 1480607940000 }, "status": "NON" } ]', 'title' => ''], + ], + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '1234567', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The objects that were returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每页展示数目', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'OnCallSchedules' => [ - 'description' => 'The information about the scheduling policy.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The information about the scheduling policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '排班策略ID', - 'description' => 'The ID of the scheduling policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'title' => '排班策略名称', - 'description' => 'The name of the scheduling policy.'."\n", - 'type' => 'string', - 'example' => 'OnCallSchedule_test', - ], - 'Description' => [ - 'title' => '排班策略描述', - 'description' => 'The description of the scheduling policy.'."\n", - 'type' => 'string', - 'example' => 'Test scheduling policy'."\n", - ], - ], - ], - ], - ], - ], + 'Data' => ['description' => 'The struct returned.'."\n", 'type' => 'string', 'example' => '-', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '1234567', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"OnCallSchedules\\": [\\n {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"OnCallSchedule_test\\",\\n \\"Description\\": \\"测试排班策略\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListOnCallSchedulesResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <PageBean>\\n <Total>24</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <OnCallSchedules>\\n <Id>1234</Id>\\n <Name>OnCallSchedule_test</Name>\\n <Description>测试排版策略</Description>\\n </OnCallSchedules>\\n </PageBean>\\n</ListOnCallSchedulesResponse>","errorExample":""}]', - 'title' => 'ListOnCallSchedules', - ], - 'GetOnCallSchedulesDetail' => [ - 'summary' => 'Queries the information about a scheduling policy.', - 'methods' => [ - 'get', + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"-\\",\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"AlertId\\": 1234567\\n}","type":"json"}]', + 'title' => 'Update an alert rule for monitoring', + 'summary' => 'You can invoke the UpdateAlertRule API to update an alert rule.', + 'description' => 'This API is no longer maintained. Use the CreateOrUpdateAlertRule API of the new alert management system to create or modify an alert rule.', + 'requestParamsDescription' => '## Additional Notes on Parameter **TemplageAlertConfig**'."\n" + ."\n" + .'**Sample and Description of Alert Template JSON String**'."\n" + ."\n" + .'```', + 'changeSet' => [ + ['createdAt' => '2023-09-11T08:40:40.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'translator' => 'machine', + ], + 'UpdateDispatchRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ 'operationType' => 'none', + 'abilityTreeCode' => '44519', + 'abilityTreeNodes' => ['FEATUREarmsVBCGEE'], ], 'parameters' => [ [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'title' => '排班策略ID', - 'description' => 'The ID of the scheduling policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1234', - ], - ], - [ - 'name' => 'StartTime', + 'name' => 'DispatchRule', 'in' => 'query', - 'schema' => [ - 'title' => '查询排班人开始时间:yyyy-MM-dd', - 'description' => 'The date from which the shift starts. Format: `yyyy-MM-dd`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-10-01', - ], + 'schema' => ['description' => 'The dispatch rule configuration. The value is a JSON string. For more information about this parameter, see the following **additional information about the DispatchRule parameter**.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '{ "id": 123, "system": false, "ruleid": 10282, "name": "Prometheus Alert", "labelMatchExpressionGrid": { "labelMatchExpressionGroups": [ { "labelMatchExpressions": [ { "key": "_aliyun_arms_involvedObject_kind", "value": "app", "operator": "eq" } ] } ] }, "dispatchType": "CREATE_ALERT/DISCARD_ALERT", "isRecover": true, "groupRules": [ { "groupId": 1, "groupingFields": [ "alertname" ], "groupWait": 10, "groupInterval": 15, "repeatInterval": 20 } ], "notifyRules": [ { "notifyObjects": [ { "notifyType": "ARMS_CONTACT", "name": "JohnDoe", "notifyObjectId": 1 }, { "notifyType": "ARMS_CONTACT_GROUP", "name": "JohnDoe_group", "notifyObjectId": 2 } ], "notifyChannels":["dingTalk","wechat","webhook","email"] }, ], }', 'title' => ''], ], [ - 'name' => 'EndTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => 'String.Class 查询排班人结束时间:yyyy-MM-dd', - 'description' => 'The date on which the shift ends. Format: `yyyy-MM-dd`.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2022-10-30', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], - 'Data' => [ - 'title' => '排班策略详情信息', - 'description' => 'The information about the scheduling policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '排班策略ID', - 'description' => 'The ID of the scheduling policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234', - ], - 'Name' => [ - 'title' => '排名策略名称', - 'description' => 'The name of the scheduling policy.'."\n", - 'type' => 'string', - 'example' => 'Scheduling policy test'."\n", - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The description of the scheduling policy.'."\n", - 'type' => 'string', - 'example' => 'Test'."\n", - ], - 'AlertRobotId' => [ - 'description' => 'The URL of the DingTalk chatbot, which is used to receive notifications about shift changes.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******', - ], - 'ScheduleLayers' => [ - 'description' => 'The information about the shift.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'ContactIds' => [ - 'description' => 'The ID list of users on duty.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The ID of the user on duty.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '[123, 234, 456]', - ], - ], - 'StartTime' => [ - 'description' => 'The date on which the shift change took effect.'."\n", - 'type' => 'string', - 'example' => '2022-10-01'."\n", - ], - 'ShiftLength' => [ - 'description' => 'The shift cycle. Unit: hours.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '8', - ], - 'RotationType' => [ - 'description' => 'The type of the shift. Valid values:'."\n" - ."\n" - .'* DAY'."\n" - .'* WEEK'."\n" - .'* CUSTOM'."\n", - 'type' => 'string', - 'example' => 'DAY', - ], - 'Restrictions' => [ - 'description' => 'The limit on the time of the shift.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RestrictionType' => [ - 'description' => 'The type of the limit. Valid values:'."\n" - ."\n" - .'* daily_restriction'."\n" - .'* weekly_restriction'."\n", - 'type' => 'string', - 'example' => 'daily_restriction', - ], - 'StartTimeOfDay' => [ - 'description' => 'The start time of the shift per day.'."\n", - 'type' => 'string', - 'example' => '09:00', - ], - 'EndTimeOfDay' => [ - 'description' => 'The end time of the shift per day.'."\n", - 'type' => 'string', - 'example' => '18:00', - ], - ], - ], - ], - ], - ], - ], - 'RenderedLayerEntries' => [ - 'description' => 'The scheduled users on duty within a time range.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'description' => 'The date from which the scheduled user was supposed to start shift work.'."\n", - 'type' => 'string', - 'example' => '2022-10-01', - ], - 'End' => [ - 'description' => 'The date on which the scheduled user was supposed to complete shift work.'."\n", - 'type' => 'string', - 'example' => '2022-10-30', - ], - 'SimpleContact' => [ - 'description' => 'The information about the scheduled user.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the scheduled user.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Name' => [ - 'description' => 'The name of the scheduled user.'."\n", - 'type' => 'string', - 'example' => 'Employee 1'."\n", - ], - ], - ], - ], - ], - ], - ], - 'RenderedSubstitudeEntries' => [ - 'description' => 'The information about the substitutes within a time range.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'description' => 'The date from which the substitute was supposed to start shift work.'."\n", - 'type' => 'string', - 'example' => '2022-10-01', - ], - 'End' => [ - 'description' => 'The date on which the substitute was supposed to complete shift work.'."\n", - 'type' => 'string', - 'example' => '2022-10-30', - ], - 'SimpleContact' => [ - 'description' => 'The information about the substitute.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the substitute.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '234', - ], - 'Name' => [ - 'description' => 'The name of the substitute.'."\n", - 'type' => 'string', - 'example' => 'Employee 2'."\n", - ], - ], - ], - ], - ], - ], - 'RenderedFinnalEntries' => [ - 'description' => 'The information about the final user on duty.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Start' => [ - 'description' => 'The date from which the user started shift work.'."\n", - 'type' => 'string', - 'example' => '2022-10-01', - ], - 'End' => [ - 'description' => 'The date on which the user completed shift work.'."\n", - 'type' => 'string', - 'example' => '2022-10-30', - ], - 'SimpleContact' => [ - 'description' => 'The information about the user on duty.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'description' => 'The ID of the user on duty.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Name' => [ - 'description' => 'The name of the user on duty.'."\n", - 'type' => 'string', - 'example' => 'Employee 1'."\n", - ], - ], - ], - ], - ], - ], - ], - ], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* `true`: The request was successful.'."\n" + .'* `false`: The request failed.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Data\\": {\\n \\"Id\\": 1234,\\n \\"Name\\": \\"排班策略测试\\",\\n \\"Description\\": \\"测试\\",\\n \\"AlertRobotId\\": 0,\\n \\"ScheduleLayers\\": [\\n {\\n \\"ContactIds\\": [\\n 0\\n ],\\n \\"StartTime\\": \\"2022-10-01\\\\n\\",\\n \\"ShiftLength\\": 8,\\n \\"RotationType\\": \\"DAY\\",\\n \\"Restrictions\\": [\\n {\\n \\"RestrictionType\\": \\"daily_restriction\\",\\n \\"StartTimeOfDay\\": \\"09:00\\",\\n \\"EndTimeOfDay\\": \\"18:00\\"\\n }\\n ]\\n }\\n ],\\n \\"RenderedLayerEntries\\": [\\n [\\n {\\n \\"Start\\": \\"2022-10-01\\",\\n \\"End\\": \\"2022-10-30\\",\\n \\"SimpleContact\\": {\\n \\"Id\\": 123,\\n \\"Name\\": \\"员工1\\"\\n }\\n }\\n ]\\n ],\\n \\"RenderedSubstitudeEntries\\": [\\n {\\n \\"Start\\": \\"2022-10-01\\",\\n \\"End\\": \\"2022-10-30\\",\\n \\"SimpleContact\\": {\\n \\"Id\\": 234,\\n \\"Name\\": \\"员工2\\"\\n }\\n }\\n ],\\n \\"RenderedFinnalEntries\\": [\\n {\\n \\"Start\\": \\"2022-10-01\\",\\n \\"End\\": \\"2022-10-30\\",\\n \\"SimpleContact\\": {\\n \\"Id\\": 123,\\n \\"Name\\": \\"员工1\\"\\n }\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'GetOnCallSchedulesDetail', - ], - 'ListSilencePolicies' => [ - 'summary' => 'Queries the information of a silence policy list.', - 'methods' => [ - 'get', - 'post', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDispatchRuleResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <Success>true</Success>\\n</UpdateDispatchRuleResponse>","errorExample":""}]', + 'title' => 'UpdateDispatchRule', + 'summary' => 'Modifies a dispatch policy.', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateNotificationPolicy接口创建或修改通知策略。', + 'requestParamsDescription' => '## Additional information about the **DispatchRule** parameter'."\n" + ."\n" + .'**JSON string example and description**'."\n" + ."\n" + .'```'."\n" + ."\n" + .'{'."\n" + .' "id": 123, // The ID of the dispatch policy. '."\n" + .' "system": false, // Specifies whether the dispatch rule is editable. Valid values: true: not editable. false: editable. '."\n" + .' "ruleid": 10282, // The ID of the dispatch rule. '."\n" + .' "name": "Prometheus Alert", // The name of the dispatch policy. '."\n" + .' "labelMatchExpressionGrid": {'."\n" + .' "labelMatchExpressionGroups": [ // Sets the dispatch rule. '."\n" + .' {'."\n" + .' "labelMatchExpressions": ['."\n" + .' {'."\n" + .' "key": "_aliyun_arms_involvedObject_kind", // The key of the tag of the dispatch rule. For more information, see the next section. '."\n" + .' "value": "app", // The value of the tag. '."\n" + .' "operator": "eq" // The operator used in the dispatch rule. Valid values: eq: equals to. re: matches a regular expression. '."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dispatchType": "CREATE_ALERT/DISCARD_ALERT", // The alert handling method. Valid values: CREATE_ALERT: generates an alert. DISCARD_ALERT: discards the alert event and generates no alert.'."\n" + .' "isRecover": true, // Specifies whether to send the restored alert. Valid values: true: sends the alert. false: does not send the alert. '."\n" + .' "groupRules": [ // Sets the event group. '."\n" + .' {'."\n" + .' "groupId": 1, // The ID of the group. '."\n" + .' "groupingFields": [ // The fields that are used to group events. Events with the same field content are assigned to a group. Alerts with the same specified grouping field are sent to the handler in separate notifications. '."\n" + .' "alertname"'."\n" + .' ],'."\n" + .' "groupWait": 10, // The duration for which the system waits after the first alert is sent. After the duration, all alerts are sent in a single notification to the handler. '."\n" + .' "groupInterval": 15, // The grouping interval. During the silence period of repeated alerts, if new alerts are generated, they will be sent after the group waiting time. '."\n" + .' "repeatInterval": 20 // The silence period of repeated alerts. All alerts are repeatedly sent at specified intervals until the alerts are cleared. '."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyRules": [ // Sets the notification rule. '."\n" + .' {'."\n" + .' "notifyObjects": ['."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT", // The type of the alert contact. Valid values: ARMS_CONTACT: contact. ARMS_CONTACT_GROUP: contact group. '."\n" + .' "name": "JohnDoe", // The name of the contact or contact group. '."\n" + .' "notifyObjectId": 1 // The ID of the contact or contact group. '."\n" + .' },'."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT_GROUP",'."\n" + .' "name": "JohnDoe_group",'."\n" + .' "notifyObjectId": 2'."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyChannels":["dingTalk","wechat","webhook","email"] // The notification method. Valid values: dingTalk, sms, webhook, email, and wechat. '."\n" + .' },'."\n" + .' ],'."\n" + .'}'."\n" + .'```'."\n" + ."\n" + .'**Enumerated keys of the tag of the dispatch rule**'."\n" + ."\n" + .'* `_aliyun_arms_userid`: user ID'."\n" + .'* `_aliyun_arms_involvedObject_kind`: type of the associated object'."\n" + .'* `_aliyun_arms_involvedObject_id`: ID of the associated object'."\n" + .'* `_aliyun_arms_involvedObject_name`: name of the associated object'."\n" + .'* `_aliyun_arms_alert_name`: alert name'."\n" + .'* `_aliyun_arms_alert_rule_id`: alert rule ID'."\n" + .'* `_aliyun_arms_alert_type`: alert type'."\n" + .'* `_aliyun_arms_alert_level`: alert severity'."\n", + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + 'changeSet' => [ + ['createdAt' => '2024-06-21T08:17:50.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + ], + 'UpdateEnvCustomJob' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '静默策略名称', - 'description' => 'The name of the silence policy.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'silencepolicy_test', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'Size', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '每页战术数目', - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ - 'name' => 'IsDetail', + 'name' => 'CustomJobName', 'in' => 'query', - 'schema' => [ - 'title' => '是否查询详情信息', - 'description' => 'Specifies whether to query the details of a silence policy. Valid values:'."\n" - ."\n" - .'* `true`: Details of the silence policy are queried.'."\n" - .'* `false`: Details about notification policies are not queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The name of the custom job.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob1', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Status', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The ID of the region.'."\n", + 'title' => '', + 'description' => 'The status of the custom job. Valid values: run and stop.'."\n", 'type' => 'string', 'required' => false, - 'example' => 'cn-hangzhou', + 'docRequired' => false, + 'example' => 'run', + 'enum' => ['run', 'stop'], ], ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['description' => 'The YAML configuration string.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '参见补充说明。', 'title' => ''], + ], ], 'responses' => [ 200 => [ @@ -42819,659 +29206,235 @@ 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - 'PageBean' => [ - 'title' => '分页对象', - 'description' => 'The returned pages.'."\n", - 'type' => 'object', - 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The number of silence policies that were returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The number of the page returned.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每页数目', - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'SilencePolicies' => [ - 'title' => '静默策略列表', - 'description' => 'The queried silence policies.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'A silence policy.'."\n", - 'type' => 'object', - 'properties' => [ - 'Id' => [ - 'title' => '静默策略ID', - 'description' => 'The ID of the silence policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Name' => [ - 'title' => '静默策略名称', - 'description' => 'The name of the silence policy.'."\n", - 'type' => 'string', - 'example' => 'silencepolicy_test', - ], - 'MatchingRules' => [ - 'title' => '事件匹配规则列表', - 'description' => 'The matching rules.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The matching rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'MatchingConditions' => [ - 'title' => '匹配条件', - 'description' => 'The matching conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'An array of matching condition objects.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'title' => '条件字段', - 'description' => 'The key of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'altertname', - ], - 'Value' => [ - 'title' => '条件字段值', - 'description' => 'The value of the matching condition.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'Operator' => [ - 'title' => '对应关系', - 'description' => 'The logical operator of the matching condition. Valid values:'."\n" - ."\n" - .'* `eq`: equal to'."\n" - .'* `neq`: not equal to'."\n" - .'* `in`: contains'."\n" - .'* `nin`: does not contain'."\n" - .'* `re`: regular expression match'."\n" - .'* `nre`: regular expression mismatch'."\n", - 'type' => 'string', - 'example' => 'eq', - ], - ], - ], - ], - ], - ], - ], - 'State' => [ - 'title' => '静默策略是否启用，enable 启用，disable 停用', - 'description' => 'Indicates whether the silence policy is enabled. Valid values: enable and disable.'."\n", - 'type' => 'string', - 'example' => 'enable', - ], - 'TimeSlots' => [ - 'description' => 'Effective period.'."\n", - 'type' => 'string', - 'example' => '[{"endTime":"00:00","endWeek":"7","startTime":"00:00","startWeek":"1"}]', - ], - 'TimePeriod' => [ - 'description' => 'The effective time. Valid values: WEEK: weekly DAY: daily'."\n", - 'type' => 'string', - 'example' => 'WEEK', - ], - 'EffectiveTimeType' => [ - 'description' => 'The effective type. Valid values: PERMANENT: The policy is effective permanently. CYCLE_EFFECT: The policy is effective cyclically. CUSTOM_TIME: The policy is effective during a custom time period.'."\n", - 'type' => 'string', - 'example' => 'PERMANENT', - ], - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'Code' => ['description' => 'The status code or error code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"SilencePolicies\\": [\\n {\\n \\"Id\\": 123,\\n \\"Name\\": \\"silencepolicy_test\\",\\n \\"MatchingRules\\": [\\n {\\n \\"MatchingConditions\\": [\\n {\\n \\"Key\\": \\"altertname\\",\\n \\"Value\\": \\"test\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ],\\n \\"State\\": \\"enable\\",\\n \\"TimeSlots\\": \\"[{\\\\\\"endTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\\\"endWeek\\\\\\":\\\\\\"7\\\\\\",\\\\\\"startTime\\\\\\":\\\\\\"00:00\\\\\\",\\\\\\"startWeek\\\\\\":\\\\\\"1\\\\\\"}]\\",\\n \\"TimePeriod\\": \\"WEEK\\",\\n \\"EffectiveTimeType\\": \\"PERMANENT\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<ListSilencePoliciesResponse>\\n <RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <SilencePolicies>\\n <Id>123</Id>\\n <Name>silencepolicy_test</Name>\\n <MatchingRules>\\n <MatchingConditions>\\n <Key>altertname</Key>\\n <Value>test</Value>\\n <Operator>eq</Operator>\\n </MatchingConditions>\\n </MatchingRules>\\n </SilencePolicies>\\n </PageBean>\\n</ListSilencePoliciesResponse>","errorExample":""}]', - 'title' => 'ListSilencePolicies', - ], - 'ListAlerts' => [ - 'summary' => 'Queries the alert sending history.', - 'methods' => [ - 'get', - 'post', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateEnvCustomJob', + 'summary' => 'Updates a custom job for an environment.', + 'extraInfo' => 'ConfigYaml示例：'."\n" + .'```'."\n" + .'scrape_configs:'."\n" + .'- job_name: job-demo1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .'- job_name: job-demo2'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scrape_interval: 30s'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .' http_sd_configs:'."\n" + .' - url: 127.0.0.1:9090'."\n" + .' refresh_interval: 30s'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvCustomJob'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'UpdateEnvDropMetricsRule' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AlertName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '告警名称', - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test alert'."\n", - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'State', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => '告警状态(0 - 待处理， 1 - 处理中， 2 - 已处理)', - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is pending.'."\n" - .'* 1: The alert is being handled.'."\n" - .'* 2: The alert is handled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2', - ], + 'schema' => ['description' => 'The language. Valid values:'."\n" + ."\n" + .'* zh (default)'."\n" + .'* en', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'Severity', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '告警等级(P1~P6)', - 'description' => 'The severity level of the alert. Valid values: P6, P5, P4, P3, P2, and P1. The preceding values are listed in ascending order of severity.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'P6', - ], + 'schema' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx', 'title' => ''], ], [ - 'name' => 'DispatchRuleId', - 'in' => 'query', - 'schema' => [ - 'title' => '通知策略ID', - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '12345', - ], + 'name' => 'DropMetrics', + 'in' => 'formData', + 'schema' => ['description' => 'The metric to be discarded. Separate multiple metrics with line feeds.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'metric_1'."\n" + .'metric_2'."\n" + .'metric_3'], ], - [ - 'name' => 'IntegrationType', - 'in' => 'query', + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'title' => '集成类型', - 'description' => 'The integration type.'."\n" - ."\n" - .'* ARMS'."\n" - .'* CLOUD_MONITOR'."\n" - .'* MSE'."\n" - .'* ARMS_CLOUD_DIALTEST'."\n" - .'* PROMETHEUS'."\n" - .'* LOG_SERVICE'."\n" - .'* CUSTOM'."\n" - .'* ARMS_PROMETHEUS'."\n" - .'* ARMS_APP_MON'."\n" - .'* ARMS_FRONT_MON'."\n" - .'* ARMS_CUSTOM'."\n" - .'* XTRACE'."\n" - .'* GRAFANA'."\n" - .'* ZABBIX'."\n" - .'* SKYWALKING'."\n" - .'* EVENT_BRIDGE'."\n" - .'* NAGIOS'."\n" - .'* OPENFALCON'."\n" - .'* ARMS_INSIGHTS'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ARMS_APP_MON', + 'title' => 'Schema of Response', + 'description' => 'The response schema.'."\n", + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****'], + 'Code' => ['description' => 'The status code. 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The returned data.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Message' => ['description' => 'The error message returned if the call failed.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateEnvDropMetricsRule', + 'summary' => 'Updates a discarded metric rule in the environment.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'translator' => 'manual', + ], + 'UpdateEnvPodMonitor' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', - 'description' => 'The start time of the alert sending history that you want to query. Specify the time in the `YYYY-MM-DD HH:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-10 00:00:00', - ], + 'AK' => [], ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ - 'name' => 'EndTime', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', - 'description' => 'The end time of the alert sending history that you want to query. Specify the time in the `YYYY-MM-DD HH:mm:ss` format.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '2021-12-22 23:59:59', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ShowEvents', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'title' => '默认不查事件，showEvents=true才查', - 'description' => 'Specifies whether to query the events that correspond to alerts. Valid values:'."\n" - ."\n" - .'* `false` (default value): The events are not queried.'."\n" - .'* `true`: The events are queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The language. Valid values:'."\n" + ."\n" + .'* zh (default value): Chinese'."\n" + .'* en: English'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'ShowActivities', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'title' => '默认不查活动记录，showActivities=true才查，只查最近3天的内容', - 'description' => 'Specifies whether to query the activities that correspond to alerts. Valid values:'."\n" - ."\n" - .'* `false` (default value): The activities are not queried.'."\n" - .'* `true`: The activities in the last three days are queried.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', - ], + 'schema' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ - 'name' => 'Page', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'title' => '页数', - 'description' => 'The number of the page to return.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1', - ], + 'schema' => ['title' => '', 'description' => 'The namespace where the PodMonitor resides.'."\n", 'type' => 'string', 'required' => true, 'example' => 'arms-prom'], ], [ - 'name' => 'Size', + 'name' => 'PodMonitorName', 'in' => 'query', - 'schema' => [ - 'title' => '每页展示数目', - 'description' => 'The number of alerts to return on each page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '20', - ], + 'schema' => ['description' => 'The name of the PodMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms-admin-pm1', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Checks whether the format is valid and whether targets are matched.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], ], [ - 'name' => 'Owner', - 'in' => 'query', - 'schema' => [ - 'description' => 'The notification object configured in the notification policy, responsible for handling alerts.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Alice', - ], + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['description' => 'The YAML configuration file of the ServiceMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '参见补充说明。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'title' => '请求ID', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', - ], - 'PageBean' => [ - 'title' => '返回结构体', - 'description' => 'The struct returned.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****'], + 'Code' => ['description' => 'The response code.'."\n" + ."\n" + .'> The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned struct.'."\n", 'type' => 'object', 'properties' => [ - 'Total' => [ - 'title' => '总数', - 'description' => 'The total number of queried alerts.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Page' => [ - 'title' => '页数', - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'Size' => [ - 'title' => '每页展示数目', - 'description' => 'The number of alerts returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'ListAlerts' => [ - 'title' => '告警发送历史信息组', - 'description' => 'The queried alert notification history records.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The object struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlertName' => [ - 'title' => '告警名称', - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Test alert'."\n", - ], - 'Severity' => [ - 'title' => '告警等级(P1~P6)', - 'description' => 'The severity level of the alert. Valid values: P6, P5, P4, P3, P2, and P1. The preceding values are listed in ascending order of severity.'."\n", - 'type' => 'string', - 'example' => 'P6', - ], - 'State' => [ - 'title' => '告警状态(0 - 待处理， 1 - 处理中， 2 - 已处理)', - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* 0: The alert is pending.'."\n" - .'* 1: The alert is being handled.'."\n" - .'* 2: The alert is handled.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '0', - ], - 'DispatchRuleId' => [ - 'title' => '通知策略ID', - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '12345', - ], - 'DispatchRuleName' => [ - 'title' => '通知策略名称', - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'DingTalk Notification'."\n", - ], - 'CreateTime' => [ - 'title' => '创建时间', - 'description' => 'The time when the alert was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-18 00:21:35', - ], - 'Activities' => [ - 'title' => '活动列表', - 'description' => 'The list of activities.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of each activity.'."\n", - 'type' => 'object', - 'properties' => [ - 'Time' => [ - 'title' => '时间', - 'description' => 'The operation time of the activity.'."\n", - 'type' => 'string', - 'example' => '2021-12-20 19:08:57', - ], - 'Type' => [ - 'title' => '活动类型', - 'description' => 'The type of the activity. Valid values:'."\n" - ."\n" - .'* 1: The alert is claimed.'."\n" - .'* 2: The alert is disclaimed.'."\n" - .'* 3: A comment is added for the alert.'."\n" - .'* 4: The alert is disabled.'."\n" - .'* 5: An alert notification is sent.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'HandlerName' => [ - 'title' => '处理人名称', - 'description' => 'The name of the handler.'."\n", - 'type' => 'string', - 'example' => 'O\\&M Engineer A'."\n", - ], - 'Description' => [ - 'title' => '描述', - 'description' => 'The description of the activity.'."\n", - 'type' => 'string', - 'example' => '\\[Alert Claimed] The alert is claimed'."\n", - ], - 'Content' => [ - 'title' => '通知内容', - 'description' => 'The content of the alert notification.'."\n", - 'type' => 'string', - 'example' => '\\[Notification policy: Send notifications to DingTalk groups] Host monitoring. Host IP address: 10.76.XX.XX. Average memory usage of the host in the last 1 minute ≥ 1.0%. Current value: 84.7454%.'."\n", - ], - ], - ], - ], - 'AlertEvents' => [ - 'title' => '事件列表', - 'description' => 'The list of events.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of each event.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlertName' => [ - 'title' => '事件名称', - 'description' => 'The name of the event.'."\n", - 'type' => 'string', - 'example' => 'Test-triggered alert'."\n", - ], - 'Severity' => [ - 'title' => '事件等级', - 'description' => 'The severity level of the event. Valid values:'."\n" - ."\n" - .'* critical'."\n" - .'* error'."\n" - .'* warning'."\n" - .'* info'."\n", - 'type' => 'string', - 'example' => 'warning', - ], - 'State' => [ - 'title' => '告警状态Active("Active"), * Inhibited("Inhibited"), * Silenced("Silenced"), * Resolved("Resolved")', - 'description' => 'The status of the event. Valid values:'."\n" - ."\n" - .'* Active: The event is not cleared.'."\n" - .'* Silenced: The event is silenced.'."\n" - .'* Resolved: The event is cleared.'."\n", - 'type' => 'string', - 'example' => 'Active', - ], - 'StartTime' => [ - 'title' => '开始时间', - 'description' => 'The time when the event started.'."\n", - 'type' => 'string', - 'example' => '2022-01-18 00:14:00', - ], - 'EndTime' => [ - 'title' => '结束时间', - 'description' => 'The time when the event ended.'."\n", - 'type' => 'string', - 'example' => '2022-01-19 17:10:31', - ], - 'ReceiveTime' => [ - 'title' => '事件接受时间', - 'description' => 'The time when the event was created.'."\n", - 'type' => 'string', - 'example' => '2022-01-19 17:05:42', - ], - 'IntegrationName' => [ - 'title' => '集成名称', - 'description' => 'The name of the integration that corresponds to the alert event.'."\n", - 'type' => 'string', - 'example' => 'ARMS', - ], - 'IntegrationType' => [ - 'title' => '集成类型', - 'description' => 'The type of the integration that corresponds to the alert event. Valid values:'."\n" - ."\n" - .'* ARMS'."\n" - .'* CLOUD_MONITOR'."\n" - .'* MSE'."\n" - .'* ARMS_CLOUD_DIALTEST'."\n" - .'* PROMETHEUS'."\n" - .'* LOG_SERVICE'."\n" - .'* CUSTOM'."\n" - .'* ARMS_PROMETHEUS'."\n" - .'* ARMS_APP_MON'."\n" - .'* ARMS_FRONT_MON'."\n" - .'* ARMS_CUSTOM'."\n" - .'* XTRACE'."\n" - .'* GRAFANA'."\n" - .'* ZABBIX'."\n" - .'* SKYWALKING'."\n" - .'* EVENT_BRIDGE'."\n" - .'* NAGIOS'."\n" - .'* OPENFALCON'."\n" - .'* ARMS_INSIGHTS'."\n", - 'type' => 'string', - 'example' => 'ARMS_APP_MON', - ], - 'GeneratorURL' => [ - 'title' => '事件地址', - 'description' => 'The URL of the event.'."\n", - 'type' => 'string', - 'example' => 'http://arms.console.aliyun.com', - ], - 'Description' => [ - 'title' => '事件描述', - 'description' => 'The description of the event.'."\n", - 'type' => 'string', - 'example' => 'Host monitoring. Host IP address: 10.76.XX.XX. Average memory usage of the host in the last 1 minute ≥ 1.0%. Current value: 84.7454%.'."\n", - ], - 'Annotations' => [ - 'description' => 'The annotations.'."\n", - 'type' => 'string', - 'example' => '{ "_aliyun_arms_alert_value":"4.0" "_aliyun_arms_alert_traceId":"ac10c43116421327442277073d5461-105075299"}', - 'title' => '', - ], - 'Labels' => [ - 'title' => '标签列表', - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => '{ "severity":"warning" "_aliyun_arms_alert_level":"ERROR" "_aliyun_arms_entropy":"0.30170457417889235"}', - ], - ], - ], - ], - 'AlertId' => [ - 'title' => '告警ID', - 'description' => 'The alert ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '2279', - ], - 'Solution' => [ - 'title' => '告警解决方案', - 'description' => 'The Alert solution.', - 'type' => 'string', - 'example' => '--', - ], - 'Owner' => [ - 'description' => 'The notification object configured in the notification policy, responsible for handling alerts.', - 'type' => 'string', - 'example' => 'Alice', - ], - 'Handler' => [ - 'description' => 'Alarm handler.', - 'type' => 'string', - 'example' => 'Alice', - ], - 'AcknowledgeTime' => [ - 'description' => 'Time to claim the alarm.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - 'default' => '-1', - ], - 'RecoverTime' => [ - 'description' => 'Alarm recovery time.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '-1', - 'default' => '-1', - ], - 'NotifyRobots' => [ - 'description' => 'The contact card of an instant messaging app.'."\n", - 'type' => 'string', - 'example' => 'Test Robot', - ], - 'Describe' => [ - 'description' => 'The description of a event execution status.'."\n", - 'type' => 'string', - 'example' => '[Notification Strategy: ARMS Front-end Alarm]\\nPage Indicator Page Name: Home JS Error Number Average in the last 5 minutes >= 1.0 times, current value 1.0000 times\\n', - ], - ], - ], - ], + 'MatchedMsg' => ['title' => '', 'description' => 'Indicates whether targets are matched.'."\n", 'type' => 'string', 'example' => '匹配成功。'], + 'MatchedTargetCount' => ['title' => '', 'description' => 'The number of matched targets.'."\n", 'type' => 'string', 'example' => '1'], ], + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'description' => 'The returned error message.'."\n", - 'type' => 'string', - 'example' => 'alert.manager.error.code.signature.invalid', - ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"PageBean\\": {\\n \\"Total\\": 1,\\n \\"Page\\": 1,\\n \\"Size\\": 20,\\n \\"ListAlerts\\": [\\n {\\n \\"AlertName\\": \\"告警测试\\",\\n \\"Severity\\": \\"P6\\",\\n \\"State\\": 0,\\n \\"DispatchRuleId\\": 12345,\\n \\"DispatchRuleName\\": \\"钉群通知\\",\\n \\"CreateTime\\": \\"2022-01-18 00:21:35\\",\\n \\"Activities\\": [\\n {\\n \\"Time\\": \\"2021-12-20 19:08:57\\",\\n \\"Type\\": 1,\\n \\"HandlerName\\": \\"运维A\\",\\n \\"Description\\": \\"[告警认领]认领了该告警\\",\\n \\"Content\\": \\"【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %\\"\\n }\\n ],\\n \\"AlertEvents\\": [\\n {\\n \\"AlertName\\": \\"测试触发的告警\\",\\n \\"Severity\\": \\"warning\\",\\n \\"State\\": \\"Active\\",\\n \\"StartTime\\": \\"2022-01-18 00:14:00\\",\\n \\"EndTime\\": \\"2022-01-19 17:10:31\\",\\n \\"ReceiveTime\\": \\"2022-01-19 17:05:42\\",\\n \\"IntegrationName\\": \\"ARMS\\",\\n \\"IntegrationType\\": \\"ARMS_APP_MON\\",\\n \\"GeneratorURL\\": \\"http://arms.console.aliyun.com\\",\\n \\"Description\\": \\"主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %\\",\\n \\"Annotations\\": \\"{ \\\\\\"_aliyun_arms_alert_value\\\\\\":\\\\\\"4.0\\\\\\" \\\\\\"_aliyun_arms_alert_traceId\\\\\\":\\\\\\"ac10c43116421327442277073d5461-105075299\\\\\\"}\\",\\n \\"Labels\\": \\"{ \\\\\\"severity\\\\\\":\\\\\\"warning\\\\\\" \\\\\\"_aliyun_arms_alert_level\\\\\\":\\\\\\"ERROR\\\\\\" \\\\\\"_aliyun_arms_entropy\\\\\\":\\\\\\"0.30170457417889235\\\\\\"}\\"\\n }\\n ],\\n \\"AlertId\\": 2279,\\n \\"Solution\\": \\"重启解决\\",\\n \\"Owner\\": \\"通知策略中配置的联系人通知对象\\",\\n \\"Handler\\": \\"认领、关闭告警的处理人\\",\\n \\"AcknowledgeTime\\": 0,\\n \\"RecoverTime\\": 0,\\n \\"NotifyRobots\\": \\"钉钉的名片。\\",\\n \\"Describe\\": \\"[告警通知]通过[webhook]通知了xxx(成功）\\"\\n }\\n ]\\n },\\n \\"Message\\": \\"alert.manager.error.code.signature.invalid\\"\\n}","errorExample":""},{"type":"xml","example":"<ListAlertsResponse>\\n <RequestId>2FC13182-B9AF-4E6B-BE51-72669B7C****</RequestId>\\n <PageBean>\\n <Total>1</Total>\\n <Page>1</Page>\\n <Size>20</Size>\\n <ListAlerts>\\n <AlertName>告警测试</AlertName>\\n <Severity>P6</Severity>\\n <State>0</State>\\n <DispatchRuleId>12345</DispatchRuleId>\\n <DispatchRuleName>钉群通知</DispatchRuleName>\\n <CreateTime>2022-01-18 00:21:35</CreateTime>\\n <Activities>\\n <Time>2021-12-20 19:08:57</Time>\\n <Type>1</Type>\\n <HandlerName>运维A</HandlerName>\\n <Description>[告警认领]认领了该告警</Description>\\n <Content>【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %</Content>\\n </Activities>\\n <AlertEvents>\\n <AlertName>测试触发的告警</AlertName>\\n <Severity>warning</Severity>\\n <State>Active</State>\\n <StartTime>2022-01-18 00:14:00</StartTime>\\n <EndTime>2022-01-19 17:10:31</EndTime>\\n <ReceiveTime>2022-01-19 17:05:42</ReceiveTime>\\n <IntegrationName>ARMS</IntegrationName>\\n <IntegrationType>ARMS_APP_MON</IntegrationType>\\n <GeneratorURL>http://arms.console.aliyun.com</GeneratorURL>\\n <Description>主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %</Description>\\n <Annotations>{ \\"_aliyun_arms_alert_value\\":\\"4.0\\" \\"_aliyun_arms_alert_traceId\\":\\"ac10c43116421327442277073d5461-105075299\\"}</Annotations>\\n <Labels>{ \\"severity\\":\\"warning\\" \\"_aliyun_arms_alert_level\\":\\"ERROR\\" \\"_aliyun_arms_entropy\\":\\"0.30170457417889235\\"}</Labels>\\n </AlertEvents>\\n </ListAlerts>\\n </PageBean>\\n</ListAlertsResponse>","errorExample":""}]', - 'title' => 'ListAlerts', - ], - 'BlockAlarmNotification' => [ - 'summary' => 'Blocks alert notifications. After an alert is blocked, no more notifications are sent within the specified time range.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateEnvPodMonitor', + 'summary' => 'Updates the PodMonitor of an environment.', + 'requestParamsDescription' => 'Sample ConfigYAML:'."\n" + ."\n" + .' apiVersion: monitoring.coreos.com/v1'."\n" + .' kind: PodMonitor'."\n" + .' metadata:'."\n" + .' name: arms-admin-pm1'."\n" + .' namespace: arms-prom'."\n" + .' annotations:'."\n" + .' arms.prometheus.io/discovery: \'true\''."\n" + .' spec:'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + .' release: arms-prometheus'."\n" + .' namespaceSelector:'."\n" + .' any: true '."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: 30s'."\n" + .' targetPort: 9335'."\n" + .' path: /metrics'."\n" + .' - interval: 10s'."\n" + .' targetPort: 9335'."\n" + .' path: /metrics1'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvPodMonitor'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"MatchedTargetCount\\": \\"1\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + ], + 'UpdateEnvServiceMonitor' => [ + 'summary' => 'Updates the ServiceMonitor of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43479,115 +29442,108 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AlarmId', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '133', - ], + 'schema' => ['title' => '', 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'Timeout', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of seconds that elapse before alert notifications are blocked. Unit: seconds.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '180', - ], + 'schema' => ['description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ - 'name' => 'HandlerId', + 'name' => 'Namespace', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert handler.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2044049', - ], + 'schema' => ['title' => '', 'description' => 'The namespace where the ServiceMonitor is located.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'arms-prom'], + ], + [ + 'name' => 'ServiceMonitorName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the ServiceMonitor.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'serviceMonitor1', 'title' => ''], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Specifies whether to perform only a dry run, without performing the actual request.'."\n", 'type' => 'boolean', 'required' => false, 'docRequired' => false, 'example' => 'true'], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['description' => 'The YAML configuration string.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '参见补充说明。', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', - ], - 'Result' => [ - '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. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The returned struct.'."\n", + 'type' => 'object', + 'properties' => [ + 'MatchedMsg' => ['title' => '', 'description' => 'Indicates whether targets are matched.'."\n", 'type' => 'string', 'example' => '匹配成功。'], + 'MatchedTargetCount' => ['title' => '', 'description' => 'The number of matched targets.'."\n", 'type' => 'string', 'example' => '1'], + ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateEnvServiceMonitor', + 'extraInfo' => 'ConfigYaml示例：'."\n" + .'```'."\n" + .'apiVersion: monitoring.coreos.com/v1'."\n" + .'kind: ServiceMonitor'."\n" + .'metadata:'."\n" + .' name: arms-admin1'."\n" + .' namespace: arms-prom'."\n" + .' annotations:'."\n" + .' arms.prometheus.io/discovery: \'true\''."\n" + .'spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' port: operator'."\n" + .' path: /metrics'."\n" + .' - interval: 10s'."\n" + .' port: operator1'."\n" + .' path: /metrics'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: arms-prometheus-ack-arms-prometheus'."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvServiceMonitor'], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'BlockAlarmNotification', + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Code\\": 200,\\n \\"Data\\": {\\n \\"MatchedMsg\\": \\"匹配成功。\\",\\n \\"MatchedTargetCount\\": \\"1\\"\\n },\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', ], - 'ChangeAlarmSeverity' => [ - 'summary' => 'Modifies the severity level of an alert.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpdateEnvironment' => [ + 'summary' => 'Updates the configuration of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43595,119 +29551,83 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AlarmId', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '155', - ], + 'schema' => ['description' => 'The language. Valid values: zh and en. Default value: zh.', 'type' => 'string', 'title' => '', 'required' => false, 'example' => 'zh'], ], [ - 'name' => 'Severity', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The severity level of the alert. Valid values: P1, P2, P3, and P4. P4 indicates the lowest severity, whereas P1 indicates the highest severity.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'P1', - 'enum' => [ - 'P1', - 'P2', - 'P3', - 'P4', - ], - ], + 'schema' => ['description' => 'The environment ID.', 'type' => 'string', 'required' => true, 'example' => 'env-xxxxx', 'title' => ''], ], [ - 'name' => 'HandlerId', + 'name' => 'EnvironmentName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['description' => 'The name of the environment instance.', 'type' => 'string', 'required' => false, 'docRequired' => false, 'title' => '', 'example' => 'env1'], + ], + [ + 'name' => 'FeePackage', 'in' => 'query', + 'allowEmptyValue' => true, 'schema' => [ - 'description' => 'The ID of the handler.', - 'type' => 'integer', - 'format' => 'int64', + 'description' => 'The payable resource plan. Valid values:'."\n" + ."\n" + .'- If the EnvironmentType parameter is set to CS, set the value to CS\\_Basic or CS\\_Pro. Default value: CS\\_Basic.'."\n" + ."\n" + .'- Otherwise, leave the parameter empty.', + 'type' => 'string', 'required' => false, - 'example' => '2046076', + 'docRequired' => false, + 'enum' => ['CS_Basic', 'CS_Pro'], + 'title' => '', + 'example' => 'CS_Basic', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', - ], - 'Result' => [ - 'description' => 'Indicates whether the severity level was modified.'."\n" - ."\n" - .'- `true`: The severity level was modified.'."\n" - .'- `false`: The severity level failed to be modified.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'- true'."\n" - .'- false', - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '70675725-8F11-4817-8106-CFE0AD71****'], + 'Code' => ['description' => 'The HTTP status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ChangeAlarmSeverity', - ], - 'CloseAlarm' => [ - 'summary' => 'Disables an alert. Make sure that the alert is resolved before you disable the alert. If an alert is not resolved, new alerts can be triggered even after the alert is disabled.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateEnvironment', + 'changeSet' => [ + ['createdAt' => '2024-03-22T06:09:03.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-21T07:42:17.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-19T06:40:42.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvironment'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'UpdateGrafanaWorkspace' => [ + 'summary' => 'Updates the information about a Grafana workspace.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -43715,624 +29635,902 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AlarmId', + 'name' => 'GrafanaWorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '163', - ], + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'grafana-cn-4xl3g******', 'title' => ''], ], [ - 'name' => 'Solution', + 'name' => 'GrafanaWorkspaceName', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert solution.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Restart Repair', - ], + 'schema' => ['description' => 'The workspace name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'testGrafana', 'title' => ''], ], [ - 'name' => 'HandlerId', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert handler.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2048065', - ], + 'schema' => ['description' => 'The description of the workspace.'."\n", 'type' => 'string', 'required' => false, 'example' => '线上生产环境Grafana', 'title' => ''], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', - ], - 'Result' => [ - '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. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****'], + 'Message' => ['description' => 'The error message returned for the request.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* `2XX`: The request is successful.'."\n" + .'* `3XX`: A redirection message is returned.'."\n" + .'* `4XX`: The request is invalid.'."\n" + .'* `5XX`: A server error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TraceId' => ['description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", 'type' => 'string', 'example' => 'eac0a8048716731735000007137d000b', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the update is successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'CloseAlarm', - ], - 'ClaimAlarm' => [ - 'summary' => 'Claims an alert. This operation can be used together with escalation policies. When multiple handlers are involved in alert management, each handler can call this operation to claim alerts. After an alert is claimed, the alert enters the Being Processed state.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ResourceIdIsIllegal', 'errorMessage' => 'The specified ResourceId is invalid.', 'description' => 'The parameter ResourceId is illegal.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['errorCode' => 'AccountUidAccessError', 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateGrafanaWorkspace', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGrafanaWorkspace'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'UpdateGrafanaWorkspaceVersion' => [ + 'summary' => 'Updates the version of a Grafana workspace.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'allowEmptyValue' => false, + 'schema' => ['description' => 'The region ID. Default value: cn-hangzhou.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'AlarmId', + 'name' => 'GrafanaWorkspaceId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert.'."\n" - ."\n" - .'For more information about how to obtain the ID of an alert, see [ListAlertEvents](~~2612346~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '30', - ], + 'schema' => ['description' => 'The ID of the workspace.'."\n", 'type' => 'string', 'required' => true, 'example' => 'grafana-cn-4xl3g******', 'title' => ''], ], [ - 'name' => 'HandlerId', + 'name' => 'GrafanaVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the handler.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '2046076', - ], + 'schema' => ['description' => 'The Grafana version.'."\n", 'type' => 'string', 'required' => true, 'example' => '10.0.x', 'title' => ''], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => ['description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', - ], - 'Result' => [ - '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. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'`true`'."\n" - ."\n" - .'`false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****'], + 'Message' => ['description' => 'The error message returned for the request.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Code' => ['description' => 'The HTTP status code returned for the request. Valid values:'."\n" + ."\n" + .'* `2XX`: The request is successful.'."\n" + .'* `3XX`: A redirection message is returned.'."\n" + .'* `4XX`: The request is invalid.'."\n" + .'* `5XX`: A server error occurs.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'TraceId' => ['description' => 'The ID of the trace. The ID is used to query the details of a request.'."\n", 'type' => 'string', 'example' => 'eac0a8048716731735000007137d000b', 'title' => ''], + 'Data' => ['description' => 'Indicates whether the update is successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Result\\": true,\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'ClaimAlarm', - ], - 'CreatePrometheusAlertRule' => [ - 'summary' => 'Creates an alert rule.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => 'You must specify the parameter.', 'description' => 'You must specify the parameter.'], + ['errorCode' => 'ResourceIdIsIllegal', 'errorMessage' => 'The specified ResourceId is invalid.', 'description' => 'The parameter ResourceId is illegal.'], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => 'The specified parameter is invalid.', 'description' => 'The specified parameter is invalid.'], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => 'STS authorization failed.', 'description' => 'STS authorization failed.'], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => 'Illegal user access.', 'description' => 'Illegal user access.'], + ], + 500 => [ + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['errorCode' => 'AccountUidAccessError', 'errorMessage' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateGrafanaWorkspaceVersion', + 'description' => 'Note: The list returned by this operation includes the workspaces of Developer Edition, Expert Edition, and Advanced Edition. The list does not include the workspaces of Shared Edition.'."\n", + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGrafanaWorkspaceVersion'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', + ], + 'UpdateIntegration' => [ + 'summary' => 'Modifies the information about an integration.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'create', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'name' => 'IntegrationId', + 'in' => 'formData', + 'schema' => ['description' => 'The ID of the alert integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'example' => '1234', 'title' => ''], ], [ - 'name' => 'AlertName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Prometheus_Alert', - ], + 'name' => 'IntegrationName', + 'in' => 'formData', + 'schema' => ['description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'required' => true, 'example' => '云监控集成', 'title' => ''], ], [ - 'name' => 'ClusterId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], + 'name' => 'IntegrationProductType', + 'in' => 'formData', + 'schema' => ['description' => 'The service of the alert integration. Valid values:'."\n" + ."\n" + .'* CLOUD_MONITOR: CloudMonitor'."\n" + .'* LOG_SERVICE: Log Service'."\n", 'type' => 'string', 'required' => true, 'example' => 'CLOUD_MONITOR', 'title' => ''], ], [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'- 99: custom alert'."\n" - .'- 101: Prometheus Service alert', - 'type' => 'string', - 'required' => false, - 'example' => '101', - ], + 'name' => 'Description', + 'in' => 'formData', + 'schema' => ['description' => 'The description of the alert integration.'."\n", 'type' => 'string', 'required' => false, 'example' => '测试', 'title' => ''], ], [ - 'name' => 'NotifyType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'- `ALERT_MANAGER`: Alert notifications are sent by Operation Center. This is the default value.'."\n" - .'- `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.', - 'type' => 'string', - 'required' => false, - 'example' => 'ALERT_MANAGER', - ], + 'name' => 'AutoRecover', + 'in' => 'formData', + 'schema' => ['description' => 'Specifies whether to automatically clear alert events. Valid values:'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'DispatchRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the notification policy. This parameter is required if the NotifyType parameter is set to `DISPATCH_RULE`.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10282', - ], + 'name' => 'RecoverTime', + 'in' => 'formData', + 'schema' => ['description' => 'The period of time within which alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], ], [ - 'name' => 'Expression', - 'in' => 'query', - 'schema' => [ - 'description' => 'The expression of the alert rule. The expression must follow the PromQL syntax.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', - ], + 'name' => 'DuplicateKey', + 'in' => 'formData', + 'schema' => ['description' => 'The fields whose values are deduplicated.'."\n", 'type' => 'string', 'required' => false, 'example' => 'LABEL.dimensions::LABEL.ruleId', 'title' => ''], ], [ - 'name' => 'Duration', - 'in' => 'query', - 'schema' => [ - 'description' => 'The duration. The value ranges from 1 to 1440 minutes.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '10m', - ], + 'name' => 'State', + 'in' => 'formData', + 'schema' => ['description' => 'Indicates whether the alert integration was enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Message', - 'in' => 'query', - 'schema' => [ - 'description' => 'The content of the alert notification. Tags can be referenced in the {{$labels.xxx}} format.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'The CPU utilization of ${{$labels.pod_name}} has exceeded 80%. Current value: {{$value}}%'."\n", - ], + 'name' => 'Stat', + 'in' => 'formData', + 'schema' => ['description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", 'type' => 'string', 'required' => false, 'example' => '[0,0]', 'title' => ''], ], [ - 'name' => 'Labels', - 'in' => 'query', - 'schema' => [ - 'description' => 'The tags that are described in a JSON string. You must specify the name and value of each tag.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"Value": "critical","Name": "severity"}]', - ], + 'name' => 'Liveness', + 'in' => 'formData', + 'schema' => ['description' => 'The activity of the alert integration'."\n", 'type' => 'string', 'required' => false, 'example' => 'ready', 'title' => ''], ], [ - 'name' => 'Annotations', - 'in' => 'query', - 'schema' => [ - 'description' => 'The annotations that are described in a JSON string. You must specify the name and value of each annotation.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"Value": "xxx","Name": "description"}]', - ], + 'name' => 'FieldRedefineRules', + 'in' => 'formData', + 'schema' => ['description' => 'The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created. For more information, see the description of the FieldRedefineRules parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"alertname",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警名称",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.alertName",'."\n" + .' "id":10001,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"MAP",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"severity",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + .' {'."\n" + .' "mappingValue":"critical",'."\n" + .' "mappingName":"P1",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"CRITICAL"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"error",'."\n" + .' "mappingName":"P2",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"WARN"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"warning",'."\n" + .' "mappingName":"P3",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"INFO"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"告警等级",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.triggerLevel",'."\n" + .' "id":10002,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"message",'."\n" + .' "expression":"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警描述",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10003,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"value",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警样本值",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.curValue",'."\n" + .' "id":10004,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"source",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"来源",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10007,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"ADD",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"generatorUrl",'."\n" + .' "expression":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"事件地址",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "id":10012,'."\n" + .' "fieldType":"GENERATE_URL"'."\n" + .' }'."\n" + .']', 'title' => ''], ], [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'type', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'value1', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, - ], + 'name' => 'ExtendedFieldRedefineRules', + 'in' => 'formData', + 'schema' => ['description' => 'The extended mapped fields are mapped to the fields of ARMS alerts. For more information, see the description of the ExtendedFieldRedefineRules parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"dimensions",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"dimensions",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.dimensions",'."\n" + .' "id":10013,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"expression",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"expression",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.expression",'."\n" + .' "id":10014,'."\n" + .' "fieldType":"LABEL"'."\n" + .' }'."\n" + .']', 'title' => ''], + ], + [ + 'name' => 'InitiativeRecoverField', + 'in' => 'formData', + 'schema' => ['description' => 'The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" + ."\n" + .'> Only the Log Service alert integration supports the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '$.status', 'title' => ''], + ], + [ + 'name' => 'InitiativeRecoverValue', + 'in' => 'formData', + 'schema' => ['description' => 'The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" + ."\n" + .'> Only the Log Service alert integration supports the parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => 'ok', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'PrometheusAlertRule' => [ - 'description' => 'The returned struct.'."\n", + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****'], + 'Integration' => [ + 'description' => 'The Information about the alert integration.'."\n", 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'- `1`: The alert rule is enabled.'."\n" - .'- `0`: The alert rule is disabled.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Type' => [ - 'description' => 'The type of the alert rule.', - 'type' => 'string', - 'example' => 'Kubernetes component alert'."\n", - ], - 'NotifyType' => [ - 'description' => 'The method that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'- ALERT_MANAGER: Alert notifications are sent by Operation Center.'."\n" - .'- DISPATCH_RULE: Alert notifications are sent based on the specified notification policy.', - 'type' => 'string', - 'example' => 'ALERT_MANAGER', - ], - 'Expression' => [ - 'description' => 'The expression of the alert rule.', - 'type' => 'string', - 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', - ], - 'Message' => [ - 'description' => 'The content of the alert notification. Tags can be referenced in the {{$labels.xxx}} format.', - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} has exceeded 80%. Current value: {{$value}}%'."\n", - ], - 'Duration' => [ - 'description' => 'The duration. The value ranges from 1 to 1440 minutes.'."\n", - 'type' => 'string', - 'example' => '10m', - ], - 'DispatchRuleId' => [ - 'description' => 'The ID of the notification policy.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10282', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule.', - 'type' => 'string', - 'example' => 'Prometheus_Alert', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3888704', - ], - 'ClusterId' => [ - 'description' => 'The ID of the cluster.', - 'type' => 'string', - 'example' => 'c0bad479465464e1d8c1e641b0afb****', + 'IntegrationId' => ['description' => 'The ID of the alert integration.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '1234', 'title' => ''], + 'IntegrationName' => ['description' => 'The name of the alert integration.'."\n", 'type' => 'string', 'example' => '云监控集成', 'title' => ''], + 'IntegrationProductType' => ['description' => 'The service of the alert integration. Valid values:'."\n" + ."\n" + .'* CLOUD_MONITOR: CloudMonitor'."\n" + .'* LOG_SERVICE: Log Service'."\n", 'type' => 'string', 'example' => 'CLOUD_MONITOR', 'title' => ''], + 'Description' => ['description' => 'The description of the alert integration.'."\n", 'type' => 'string', 'example' => '测试', 'title' => ''], + 'ApiEndpoint' => ['description' => 'The endpoint of the alert integration.'."\n", 'type' => 'string', 'example' => 'https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******', 'title' => ''], + 'ShortToken' => ['description' => 'The authentication token of the alert integration.'."\n", 'type' => 'string', 'example' => 'ymQBN******', 'title' => ''], + 'AutoRecover' => ['description' => 'Indicates whether alert events are automatically cleared. Valid values:'."\n" + ."\n" + .'* true (default)'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RecoverTime' => ['description' => 'The time when alert events are automatically cleared. Unit: seconds. Default value: 300.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '300', 'title' => ''], + 'DuplicateKey' => ['description' => 'The fields whose values are deduplicated.'."\n", 'type' => 'string', 'example' => 'LABEL.dimensions::LABEL.ruleId', 'title' => ''], + 'State' => ['description' => 'Indicates whether the alert integration is enabled. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Stat' => [ + 'description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The total number of alert events and the number of abnormal alert events in the last hour.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '[0,0]', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Labels' => [ - 'description' => 'The tags of the alert rule.', + 'Liveness' => ['description' => 'The activity of the alert integration'."\n", 'type' => 'string', 'example' => 'ready', 'title' => ''], + 'FieldRedefineRules' => [ + 'description' => 'The predefined mapped fields of the alert source.'."\n", 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the tag.'."\n", - 'type' => 'string', - 'example' => 'severity', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'critical', - ], - ], - 'description' => 'The tags of the alert rule.'."\n", - ], + 'items' => ['description' => 'The predefined mapped fields are mapped to the fields of ARMS alerts. The predefined mapped fields were generated when the alert integration was created.'."\n", 'type' => 'object', 'example' => '['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"alertname",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警名称",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.alertName",'."\n" + .' "id":10001,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"MAP",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"severity",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + .' {'."\n" + .' "mappingValue":"critical",'."\n" + .' "mappingName":"P1",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"CRITICAL"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"error",'."\n" + .' "mappingName":"P2",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"WARN"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"warning",'."\n" + .' "mappingName":"P3",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"INFO"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"告警等级",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.triggerLevel",'."\n" + .' "id":10002,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"message",'."\n" + .' "expression":"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警描述",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10003,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"value",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警样本值",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.curValue",'."\n" + .' "id":10004,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"source",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"来源",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10007,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"ADD",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"generatorUrl",'."\n" + .' "expression":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"事件地址",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "id":10012,'."\n" + .' "fieldType":"GENERATE_URL"'."\n" + .' }'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Annotations' => [ - 'description' => 'The annotations of the alert rule.'."\n", + 'ExtendedFieldRedefineRules' => [ + 'description' => 'The extended mapped fields of the alert source.'."\n", 'type' => 'array', - 'items' => [ - 'description' => 'The annotation of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the annotation.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} has exceeded 80%. Current value: {{$value}}%', - ], - ], - ], + 'items' => ['description' => 'The extended mapped fields are mapped to the fields of ARMS alerts.'."\n", 'type' => 'object', 'example' => '['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"dimensions",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"dimensions",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.dimensions",'."\n" + .' "id":10013,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"expression",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"expression",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.expression",'."\n" + .' "id":10014,'."\n" + .' "fieldType":"LABEL"'."\n" + .' }'."\n" + .']', 'title' => ''], + 'title' => '', + 'example' => '', ], + 'InitiativeRecoverField' => ['description' => 'The field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" + ."\n" + .'> Only Log Service supports this parameter.'."\n", 'type' => 'string', 'example' => '$.status', 'title' => ''], + 'InitiativeRecoverValue' => ['description' => 'The value of the field for clearing alert events. The system queries alert events based on the field of alert clearing events and clears the alert events.'."\n" + ."\n" + .'> Only Log Service supports this parameter.'."\n", 'type' => 'string', 'example' => 'ok', 'title' => ''], ], - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRule\\": {\\n \\"Status\\": 1,\\n \\"Type\\": \\"Kubernetes组件告警\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"10m\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<CreatePrometheusAlertRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <PrometheusAlertRule>\\n <Status>1</Status>\\n <Type>Kubernetes组件告警</Type>\\n <NotifyType>ALERT_MANAGER</NotifyType>\\n <Expression>100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\"pod_name\\\\\\", \\\\\\"$1\\\\\\", \\\\\\"pod\\\\\\", \\\\\\"(.*)\\\\\\")) by (pod_name))&gt;75</Expression>\\n <Message>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Message>\\n <Duration>1m</Duration>\\n <DispatchRuleId>10282</DispatchRuleId>\\n <AlertName>Prometheus_Alert</AlertName>\\n <AlertId>3888704</AlertId>\\n <ClusterId>c0bad479465464e1d8c1e641b0afb****</ClusterId>\\n <Labels>\\n <Name>severity</Name>\\n <Value>critical</Value>\\n </Labels>\\n <Annotations>\\n <Name>message</Name>\\n <Value>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Value>\\n </Annotations>\\n </PrometheusAlertRule>\\n</CreatePrometheusAlertRuleResponse>","errorExample":""}]', - 'title' => 'CreatePrometheusAlertRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeletePrometheusAlertRule' => [ - 'summary' => 'Deletes an alert rule of Prometheus Service.', - 'methods' => [ - 'post', - 'get', + 'title' => 'UpdateIntegration', + 'requestParamsDescription' => '### FieldRedefineRules and ExtendedFieldRedefineRules description'."\n" + ."\n" + .'Example:'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"alertname",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Alert name",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.alertName",'."\n" + .' "id":10001,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"MAP",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"severity",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + .' {'."\n" + .' "mappingValue":"critical",'."\n" + .' "mappingName":"P1",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"CRITICAL"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"error",'."\n" + .' "mappingName":"P2",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"WARN"'."\n" + .' },'."\n" + .' {'."\n" + .' "mappingValue":"warning",'."\n" + .' "mappingName":"P3",'."\n" + .' "mappingType":"MAP",'."\n" + .' "originValue":"INFO"'."\n" + .' }'."\n" + .' ],'."\n" + .' "name":"Alert level",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.triggerLevel",'."\n" + .' "id":10002,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"message",'."\n" + .' "expression":"{{$labels.namespace}} / {{$labels.dimensions}} Alert content {{ $labels.alertname }}, Current value {{$value}}.",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Alert description",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10003,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"value",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Alert sample value",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"$.curValue",'."\n" + .' "id":10004,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"imageUrl",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Alert image",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10005,'."\n" + .' "fieldType":"ANNOTATION"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"check",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Check item",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10006,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"source",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Source",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10007,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"class",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Category",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10008,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"service",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Service",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10009,'."\n" + .' "fieldType":"LABEL"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"startat",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Start time",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10010,'."\n" + .' "fieldType":"START_AT"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"EXTRACT",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"endat",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"End time",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":null,'."\n" + .' "id":10011,'."\n" + .' "fieldType":"END_AT"'."\n" + .' },'."\n" + .' {'."\n" + .' "redefineType":"ADD",'."\n" + .' "matchExpression":null,'."\n" + .' "fieldName":"generatorUrl",'."\n" + .' "expression":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"Event URL",'."\n" + .' "integrationId":1234,'."\n" + .' "jsonPath":"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}",'."\n" + .' "id":10012,'."\n" + .' "fieldType":"GENERATE_URL"'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'The following table describes the fields of the preceding parameters.'."\n" + ."\n" + .'|Field|Description|'."\n" + .'|---|---|'."\n" + .'|RedefineType|\\- MAP: maps fields such as the alert level based on a mapping table.\\- EXTRACT: uses jsonPath to map fields from a JSON file to ARMS alerts.\\- ADD: adds content mapping to ARMS alerts.\\- CONDITION: maps fields to ARMS alerts based on the specified conditions. If the specified conditions are met, jsonPath is used to map fields from a JSON file to ARMS alerts.\\- CONCAT: concatenates multiple fields into one field and then map this field to ARMS alerts.|'."\n" + .'|MatchExpression|\\- If the RedefineType field is set to CONCAT, the value of the MatchExpression field is the delimiter that is used for concatenation.\\- If the RedefineType field is set to CONDITION, the value of the MatchExpression field is the JSON string that specifies conditions.|'."\n" + .'|FieldType|\\- LABEL: the metadata of the alert. A set of labels uniquely identifies an alert event. Alert events with the same labels are compressed into one event. Example: "alertname: alert name".\\- ANNOTATION: the additional information of the alert. Annotations are not metadata. Example: "message: alert content".\\- GENERATE\\_URL: the URL of the alert event.\\- START\\_AT: the start time of the alert event.\\- END\\_AT: the end time of the alert event.|'."\n" + .'|Expression|The conditional mapping style. An escaped string value is passed to the Expression field.|'."\n" + .'|MappingRuleList|The redefinition rules of fields.|'."\n" + .'|Name|The name of the mapping rule.|'."\n" + .'|FieldName|The name of the field.|'."\n" + .'|JsonPath|The name of the source field.|'."\n" + .'|IntegrationId|The ID of the alert integration.|'."\n" + .'|Id|The primary key ID of the table for the mapped fields.|', + 'changeSet' => [ + ['createdAt' => '2023-06-12T09:33:48.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-08-11T08:16:19.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-08-11T02:43:10.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegration'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"Integration\\": {\\n \\"IntegrationId\\": 1234,\\n \\"IntegrationName\\": \\"云监控集成\\",\\n \\"IntegrationProductType\\": \\"CLOUD_MONITOR\\",\\n \\"Description\\": \\"测试\\",\\n \\"ApiEndpoint\\": \\"https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******\\",\\n \\"ShortToken\\": \\"ymQBN******\\",\\n \\"AutoRecover\\": true,\\n \\"RecoverTime\\": 300,\\n \\"DuplicateKey\\": \\"LABEL.dimensions::LABEL.ruleId\\",\\n \\"State\\": true,\\n \\"Stat\\": [\\n 0\\n ],\\n \\"Liveness\\": \\"ready\\",\\n \\"FieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"alertname\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警名称\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.alertName\\",\\n \\"id\\": 10001,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"MAP\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"severity\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [\\n {\\n \\"mappingValue\\": \\"critical\\",\\n \\"mappingName\\": \\"P1\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"CRITICAL\\"\\n },\\n {\\n \\"mappingValue\\": \\"error\\",\\n \\"mappingName\\": \\"P2\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"WARN\\"\\n },\\n {\\n \\"mappingValue\\": \\"warning\\",\\n \\"mappingName\\": \\"P3\\",\\n \\"mappingType\\": \\"MAP\\",\\n \\"originValue\\": \\"INFO\\"\\n }\\n ],\\n \\"name\\": \\"告警等级\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.triggerLevel\\",\\n \\"id\\": 10002,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"message\\",\\n \\"expression\\": \\"{{$labels.namespace}} / {{$labels.dimensions}} 发生 {{ $labels.alertname }}, 当前值 {{$value}}。\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警描述\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10003,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"value\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"告警样本值\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.curValue\\",\\n \\"id\\": 10004,\\n \\"fieldType\\": \\"ANNOTATION\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"source\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"来源\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": null,\\n \\"id\\": 10007,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"ADD\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"generatorUrl\\",\\n \\"expression\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"事件地址\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"https://cloudmonitor.console.aliyun.com/index.htm#/alarmInfo/name={{$labels.ruleId}}&searchValue=&searchType=name&searchProduct=/history/all/searchKey:{{$labels.ruleId}},startTime:{{sub $startsAt 300000}},endTime:{{$endsAt}}\\",\\n \\"id\\": 10012,\\n \\"fieldType\\": \\"GENERATE_URL\\"\\n }\\n ]\\n ],\\n \\"ExtendedFieldRedefineRules\\": [\\n [\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"dimensions\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"dimensions\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.dimensions\\",\\n \\"id\\": 10013,\\n \\"fieldType\\": \\"LABEL\\"\\n },\\n {\\n \\"redefineType\\": \\"EXTRACT\\",\\n \\"matchExpression\\": null,\\n \\"fieldName\\": \\"expression\\",\\n \\"expression\\": null,\\n \\"mappingRuleList\\": [],\\n \\"name\\": \\"expression\\",\\n \\"integrationId\\": 1234,\\n \\"jsonPath\\": \\"$.expression\\",\\n \\"id\\": 10014,\\n \\"fieldType\\": \\"LABEL\\"\\n }\\n ]\\n ],\\n \\"InitiativeRecoverField\\": \\"$.status\\",\\n \\"InitiativeRecoverValue\\": \\"ok\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"","errorExample":""}]', + ], + 'UpdateMetricDrop' => [ + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'delete', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AlertId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the ListPrometheusAlertRules operation to query the ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'minimum' => '0', - 'example' => '3888704', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID of the Prometheus monitoring alarm rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => false, 'example' => 'c3ca36c8e2693403d85c0d9f8bb1d7b6c', 'title' => ''], + ], + [ + 'name' => 'MetricDrop', + 'in' => 'query', + 'schema' => ['description' => 'The list of discarded metrics. Specify one metric name in each line.'."\n", 'type' => 'string', 'required' => false, 'example' => 'apiserver_request_duration_seconds_bucket'."\n" + .'etcd_request_duration_seconds_bucket'."\n" + .'apiserver_request_total'."\n" + .'container_tasks_state', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the alert rule was deleted. Valid values:'."\n" - ."\n" - .'* `true`: The alert rule was deleted.'."\n" - .'* `false`: The alert rule failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'Code' => [ - 'description' => 'Status code. 200 means success, other status codes are exceptions.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'More Information.', - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => 'CCCA4B88-BD7B-5A38-89AF-C09293BD4187'], + 'Data' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The response status. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DeletePrometheusAlertRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <Success>true</Success>\\n</DeletePrometheusAlertRuleResponse>","errorExample":""}]', - 'title' => 'DeletePrometheusAlertRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'staticInfo' => [ + 'substitutions' => ['ARMS::2019-08-08::UpdateEnvDropMetricsRule'], + 'returnType' => 'synchronous', + ], + 'title' => 'UpdateMetricDrop', + 'summary' => 'Updates the list of discarded metrics.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMetricDrop'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"CCCA4B88-BD7B-5A38-89AF-C09293BD4187\\",\\n \\"Data\\": \\"true\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', ], 'UpdatePrometheusAlertRule' => [ 'summary' => 'Updates a Prometheus alert rule.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -44340,170 +30538,94 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'AlertName', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'Prometheus_Alert', - ], + 'schema' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'Prometheus_Alert', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The cluster ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], + 'schema' => ['description' => 'The cluster ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], ], [ 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'Kubernetes component alert', - ], + 'schema' => ['description' => 'The type of the alert rule.', 'type' => 'string', 'required' => false, 'example' => 'Kubernetes组件告警', 'title' => ''], ], [ 'name' => 'NotifyType', 'in' => 'query', - 'schema' => [ - 'description' => 'The method that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'- `ALERT_MANAGER`: Alert notifications are sent by Operation Center. This is the default value.'."\n" - .'- `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.', - 'type' => 'string', - 'required' => false, - 'example' => 'ALERT_MANAGER', - ], + 'schema' => ['description' => 'The method that is used to send alert notifications. Valid values:'."\n" + ."\n" + .'- `ALERT_MANAGER`: Alert notifications are sent by Operation Center. This is the default value.'."\n" + ."\n" + .'- `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.', 'type' => 'string', 'required' => false, 'example' => 'ALERT_MANAGER', 'title' => ''], ], [ 'name' => 'DispatchRuleId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the notification policy. This parameter is required if the NotifyType parameter is set to `DISPATCH_RULE`.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'example' => '10282', - ], + 'schema' => ['description' => 'The ID of the notification policy. This parameter is required if the NotifyType parameter is set to `DISPATCH_RULE`.', 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '10282', 'title' => ''], ], [ 'name' => 'Expression', 'in' => 'query', - 'schema' => [ - 'description' => 'The expression of the alert rule. The expression must follow the PromQL syntax.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', - ], + 'schema' => ['description' => 'The expression of the alert rule. The expression must follow the PromQL syntax.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', 'title' => ''], ], [ 'name' => 'Duration', 'in' => 'query', - 'schema' => [ - 'description' => 'The duration. The value ranges from 1 to 1440 minutes.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The duration. The value ranges from 1 to 1440 minutes.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '1', 'title' => ''], ], [ 'name' => 'Message', 'in' => 'query', - 'schema' => [ - 'description' => 'The alert message. Tags can be referenced in the {{$labels.xxx}} format.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'The CPU utilization of ${{$labels.pod_name}} exceeds 80%. Current value: {{$value}}%', - ], + 'schema' => ['description' => 'The alert message. Tags can be referenced in the {{$labels.xxx}} format.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], ], [ 'name' => 'Labels', 'in' => 'query', - 'schema' => [ - 'description' => 'The tags that are described in a JSON string. You must specify the name and value of each tag.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"Value": "critical","Name": "severity"}]', - ], + 'schema' => ['description' => 'The tags that are described in a JSON string. You must specify the name and value of each tag.', 'type' => 'string', 'required' => false, 'example' => '[{"Value": "critical","Name": "severity"}]', 'title' => ''], ], [ 'name' => 'Annotations', 'in' => 'query', - 'schema' => [ - 'description' => 'The annotations that are described in a JSON string. You must specify the name and value of each annotation.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"Value": "xxx","Name": "description"}]', - ], + 'schema' => ['description' => 'The annotations that are described in a JSON string. You must specify the name and value of each annotation.', 'type' => 'string', 'required' => false, 'example' => '[{"Value": "xxx","Name": "description"}]', 'title' => ''], ], [ 'name' => 'AlertId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the ListPrometheusAlertRules operation to query the ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '3888704', - ], + 'schema' => ['description' => 'The ID of the alert rule. You can call the ListPrometheusAlertRules operation to query the ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'example' => '3888704', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags.'."\n", + 'description' => 'The tags.', 'type' => 'array', 'items' => [ - 'description' => 'The tag.'."\n", + 'description' => 'The tag.', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.', - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.', - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], + 'Key' => ['description' => 'The tag key.', 'type' => 'string', 'required' => false, 'example' => 'TestKey', 'title' => ''], + 'Value' => ['description' => 'The tag value.', 'type' => 'string', 'required' => false, 'example' => 'TestValue', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, 'maxItems' => 21, + 'title' => '', + 'example' => '', ], ], ], @@ -44512,188 +30634,191 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], + 'RequestId' => ['description' => 'The request ID.', 'type' => 'string', 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', 'title' => ''], 'PrometheusAlertRule' => [ - 'description' => 'The returned struct.'."\n", + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'- `1`: The alert rule is enabled.'."\n" - .'- `0`: The alert rule is disabled.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Type' => [ - 'description' => 'The type of the alert rule.', - 'type' => 'string', - 'example' => 'Kubernetes component alert', - ], - 'NotifyType' => [ - 'description' => 'The method of that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'* `ALERT_MANAGER`: Alert notifications are sent by Operation Center.'."\n" - .'* `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.'."\n", - 'type' => 'string', - 'example' => 'ALERT_MANAGER', - ], - 'Expression' => [ - 'description' => 'The expression of the alert rule.', - 'type' => 'string', - 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} exceeds 80%. Current value: {{$value}}%', - ], - 'Duration' => [ - 'description' => 'The duration. The value ranges from 1 to 1440 minutes.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'DispatchRuleId' => [ - 'description' => 'The ID of the notification policy.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10282', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule.', - 'type' => 'string', - 'example' => 'Prometheus_Alert', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3888704', - ], - 'ClusterId' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], + 'Status' => ['description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" + ."\n" + .'- `1`: The alert rule is enabled.'."\n" + ."\n" + .'- `0`: The alert rule is disabled.', 'type' => 'integer', 'format' => 'int32', 'example' => '1', 'title' => ''], + 'Type' => ['description' => 'The type of the alert rule.', 'type' => 'string', 'example' => 'Kubernetes组件告警', 'title' => ''], + 'NotifyType' => ['description' => 'The method of that is used to send alert notifications. Valid values:'."\n" + ."\n" + .'- `ALERT_MANAGER`: Alert notifications are sent by Operation Center.'."\n" + ."\n" + .'- `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.', 'type' => 'string', 'example' => 'ALERT_MANAGER', 'title' => ''], + 'Expression' => ['description' => 'The expression of the alert rule.', 'type' => 'string', 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], + 'Duration' => ['description' => 'The duration. The value ranges from 1 to 1440 minutes.', 'type' => 'string', 'example' => '1', 'title' => ''], + 'DispatchRuleId' => ['description' => 'The ID of the notification policy.', 'type' => 'integer', 'format' => 'int64', 'example' => '10282', 'title' => ''], + 'AlertName' => ['description' => 'The name of the alert rule.', 'type' => 'string', 'example' => 'Prometheus_Alert', 'title' => ''], + 'AlertId' => ['description' => 'The ID of the alert rule.', 'type' => 'integer', 'format' => 'int64', 'example' => '3888704', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the cluster.', 'type' => 'string', 'example' => 'c0bad479465464e1d8c1e641b0afb****', 'title' => ''], 'Labels' => [ - 'description' => 'The tags of the alert rule.'."\n", + 'description' => 'The tags of the alert rule.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the tag.'."\n", - 'type' => 'string', - 'example' => 'severity', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'critical', - ], + 'Name' => ['description' => 'The name of the tag.', 'type' => 'string', 'example' => 'severity', 'title' => ''], + 'Value' => ['description' => 'The value of the tag.', 'type' => 'string', 'example' => 'critical', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], 'Annotations' => [ - 'description' => 'The annotation of the alert rule.'."\n", + 'description' => 'The annotation of the alert rule.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the annotation.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} exceeds 80%. Current value: {{$value}}%', - ], + 'Name' => ['description' => 'The name of the annotation.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Value' => ['description' => 'The value of the annotation.', 'type' => 'string', 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - '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. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'success', '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' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRule\\": {\\n \\"Status\\": 1,\\n \\"Type\\": \\"Kubernetes组件告警\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"1\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<UpdatePrometheusAlertRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <PrometheusAlertRule>\\n <Status>1</Status>\\n <NotifyType>ALERT_MANAGER</NotifyType>\\n <Type>Kubernetes组件告警</Type>\\n <AlertId>3888704</AlertId>\\n <AlertName>Prometheus_Alert</AlertName>\\n <Message>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Message>\\n <ClusterId>c0bad479465464e1d8c1e641b0afb****</ClusterId>\\n <Expression>100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\"pod_name\\\\\\", \\\\\\"$1\\\\\\", \\\\\\"pod\\\\\\", \\\\\\"(.*)\\\\\\")) by (pod_name))&gt;75</Expression>\\n <DispatchRuleId>10282</DispatchRuleId>\\n <Duration>1m</Duration>\\n <Labels>\\n <Value>critical</Value>\\n <Name>severity</Name>\\n </Labels>\\n <Annotations>\\n <Value>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Value>\\n <Name>message</Name>\\n </Annotations>\\n </PrometheusAlertRule>\\n</UpdatePrometheusAlertRuleResponse>","errorExample":""}]', + 'staticInfo' => ['returnType' => 'synchronous'], 'title' => 'UpdatePrometheusAlertRule', + 'description' => 'UpdatePrometheusAlertRule 接口已不再维护，请使用 CreateOrUpdateAlertRule 接口创建或修改告警规则。', 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DescribePrometheusAlertRule' => [ - 'summary' => 'Queries the details about an alert rule for a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2023-07-31T01:50:40.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-05-11T12:16:04.000Z', 'description' => 'Request parameters changed, Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusAlertRule'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRule\\": {\\n \\"Status\\": 1,\\n \\"Type\\": \\"Kubernetes组件告警\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"1\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","type":"json"}]', + ], + 'UpdatePrometheusGlobalView' => [ + 'summary' => 'Updates the data sources of Prometheus instance for GlobalView.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'AlertId', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the ListPrometheusAlertRules operation to query the ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '3888704', - ], + 'schema' => ['description' => 'The ID of the region in which the Prometheus instance resides.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-shenzhen', 'title' => ''], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the global aggregation instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'zyGlobalView', 'title' => ''], + ], + [ + 'name' => 'MostRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID of the global aggregation instance.', 'type' => 'string', 'required' => false, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the Prometheus instance.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'required' => true, 'example' => 'global****', 'title' => ''], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => ['description' => 'The ID of the resource group to which the Prometheus instance belongs.', 'type' => 'string', 'required' => false, 'title' => '', 'example' => 'rg-acfmxyexli2****'], + ], + [ + 'name' => 'SubClustersJson', + 'in' => 'query', + 'schema' => ['description' => 'The data sources of the Prometheus instance for GlobalView.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => '['."\n" + .' {'."\n" + .' "headers":{'."\n" + ."\n" + .' },'."\n" + .' "regionId":"cn-hangzhou",'."\n" + .' "sourceType":"AlibabaPrometheus",'."\n" + .' "extras":{'."\n" + ."\n" + .' },'."\n" + .' "clusterId":"c39a1048921e04f***********",'."\n" + .' "sourceName":"arms-luyao-test",'."\n" + .' "dataSource":"",'."\n" + .' "userId":"1672753***********"'."\n" + .' },'."\n" + .' {'."\n" + .' "headers":{'."\n" + ."\n" + .' },'."\n" + .' "regionId":"cn-beijing",'."\n" + .' "sourceType":"AlibabaPrometheus",'."\n" + .' "extras":{'."\n" + ."\n" + .' },'."\n" + .' "clusterId":"c6b6485496d5b40***********",'."\n" + .' "sourceName":"agent-321-测试",'."\n" + .' "dataSource":"",'."\n" + .' "userId":"1672753***********"'."\n" + .' },'."\n" + .' {'."\n" + .' "headers":{'."\n" + ."\n" + .' },'."\n" + .' "regionId":"cn-zhangjiakou",'."\n" + .' "sourceType":"AlibabaPrometheus",'."\n" + .' "extras":{'."\n" + ."\n" + .' },'."\n" + .' "clusterId":"c261a4f3200c446***********",'."\n" + .' "sourceName":"zaifeng-cardinality-01",'."\n" + .' "dataSource":"",'."\n" + .' "userId":"1672753***********"'."\n" + .' }'."\n" + .']'], + ], + [ + 'name' => 'AllSubClustersSuccess', + 'in' => 'query', + 'schema' => ['description' => 'To edit a GlobalView aggregated instance, do you require all passed child instances to be verified successfully before creating a GlobalView instance (optional, default to false):'."\n" + ."\n" + .'- true'."\n" + ."\n" + .'- false', 'type' => 'boolean', 'docRequired' => true, 'title' => '', 'required' => true, 'example' => 'true'], ], ], 'responses' => [ @@ -44701,723 +30826,503 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'PrometheusAlertRule' => [ - 'description' => 'The returned struct.'."\n", + 'Data' => [ + 'description' => 'The returned struct.', 'type' => 'object', 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'* `1`: The alert rule is enabled.'."\n" - .'* `0`: The alert rule is disabled.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Type' => [ - 'description' => 'The type of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Kubernetes component alert'."\n", - ], - 'NotifyType' => [ - 'description' => 'The method of that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'* `ALERT_MANAGER`: Alert notifications are sent by Operation Center.'."\n" - .'* `DISPATCH_RULE`: Alert notifications are sent based on the specified notification policy.'."\n", - 'type' => 'string', - 'example' => 'ALERT_MANAGER', - ], - 'Expression' => [ - 'description' => 'The expression of the alert rule.'."\n", - 'type' => 'string', - 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', - ], - 'Message' => [ - 'description' => 'The alert message. Tags can be referenced in the {{$labels.xxx}} format.'."\n", - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} has exceeded 80%. Current value: {{$value}}%'."\n", - ], - 'Duration' => [ - 'description' => 'The duration of the alert. Valid values: 1 to 1440. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '1m', - ], - 'DispatchRuleId' => [ - 'description' => 'The ID of the notification policy. This parameter is returned if the **NotifyType** parameter is set to `DISPATCH_RULE`.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10282', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Prometheus_Alert', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3888704', - ], - 'ClusterId' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], - 'Labels' => [ - 'description' => 'The tags of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the tag.'."\n", - 'type' => 'string', - 'example' => 'severity', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'critical', - ], - ], - ], - ], - 'Annotations' => [ - 'description' => 'The annotations of the alert rule.'."\n", + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'- `true`'."\n" + ."\n" + .'- `false`', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'FailedInstances' => [ + 'description' => 'The data sources that failed to be updated.', 'type' => 'array', 'items' => [ 'type' => 'object', 'properties' => [ - 'Name' => [ - 'description' => 'The name of the annotation.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} has exceeded 80%. Current value: {{$value}}%'."\n", - ], + 'SourceName' => ['description' => 'The name of the data source.', 'type' => 'string', 'example' => 'sourcename-test', 'title' => ''], + 'SourceType' => ['title' => '', 'description' => 'The type of the data source. AlibabaPrometheus MetricStore CustomPrometheus', 'type' => 'string', 'example' => 'AlibabaPrometheus'], + 'UserId' => ['description' => 'The user ID.', 'type' => 'string', 'example' => '23784673825*******', 'title' => ''], + 'ClusterId' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'example' => 'cdb65ed2d527345*********', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], + 'title' => '', + 'example' => '', ], ], + 'title' => '', + 'example' => '', ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], + 'RequestId' => ['description' => 'The ID of the request. You can use the ID to query logs and troubleshoot issues.', 'type' => 'string', 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', 'title' => ''], + 'Message' => ['description' => 'The error message that is returned if the request failed.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The response code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRule\\": {\\n \\"Status\\": 1,\\n \\"Type\\": \\"Kubernetes组件告警\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"1m\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ]\\n },\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\"\\n}","errorExample":""},{"type":"xml","example":"<DescribePrometheusAlertRuleResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <PrometheusAlertRule>\\n <Status>1</Status>\\n <NotifyType>ALERT_MANAGER</NotifyType>\\n <Type>Kubernetes组件告警</Type>\\n <AlertId>3888704</AlertId>\\n <AlertName>Prometheus_Alert</AlertName>\\n <Message>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Message>\\n <ClusterId>c0bad479465464e1d8c1e641b0afb****</ClusterId>\\n <Expression>100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\"pod_name\\\\\\", \\\\\\"$1\\\\\\", \\\\\\"pod\\\\\\", \\\\\\"(.*)\\\\\\")) by (pod_name))&gt;75</Expression>\\n <DispatchRuleId>10282</DispatchRuleId>\\n <Duration>1m</Duration>\\n <Labels>\\n <Value>critical</Value>\\n <Name>severity</Name>\\n </Labels>\\n <Annotations>\\n <Value>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Value>\\n <Name>message</Name>\\n </Annotations>\\n </PrometheusAlertRule>\\n</DescribePrometheusAlertRuleResponse>","errorExample":""}]', - 'title' => 'DescribePrometheusAlertRule', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListPrometheusAlertRules' => [ - 'summary' => 'Queries the alert rules created for a Prometheus instance.', - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'UpdatePrometheusGlobalView', + 'changeSet' => [ + ['createdAt' => '2023-08-17T02:09:00.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-11T08:01:55.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-08-04T01:52:41.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-29T09:02:31.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-03-20T10:14:11.000Z', 'description' => 'Response parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusGlobalView'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": {\\n \\"Success\\": true,\\n \\"FailedInstances\\": [\\n {\\n \\"SourceName\\": \\"sourcename-test\\",\\n \\"SourceType\\": \\"AlibabaPrometheus\\",\\n \\"UserId\\": \\"23784673825*******\\",\\n \\"ClusterId\\": \\"cdb65ed2d527345*********\\"\\n }\\n ]\\n },\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'UpdatePrometheusInstance' => [ + 'summary' => 'Updates the information of a Prometheus instance.', + 'methods' => ['get', 'post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'list', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217860', + 'abilityTreeNodes' => ['FEATUREarmsFRX7PL'], ], 'parameters' => [ [ - 'name' => 'Name', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert rule.', - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Prometheus_Alert', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the instance.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The resource group ID of the Prometheus instance.', 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****'], ], [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], + 'allowEmptyValue' => false, + 'schema' => ['title' => '', 'description' => 'The Prometheus instance ID.', 'type' => 'string', 'required' => true, 'example' => 'vpc-xxx'], ], [ - 'name' => 'Type', + 'name' => 'StorageDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert rule.', - 'type' => 'string', - 'required' => false, - 'example' => 'Custom'."\n", - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The data retention period, in days.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90'], ], [ - 'name' => 'Status', + 'name' => 'ArchiveDuration', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'- 1: enables the alert rule.'."\n" - .'- 0: disables the alert rule.', - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'example' => '1', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The number of days for automatic archiving after storage expires. Valid values: 60, 90, 180, and 365. A value of 0 indicates no archiving.', 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '90'], ], [ - 'name' => 'MatchExpressions', + 'name' => 'EnableAuthToken', 'in' => 'query', - 'schema' => [ - 'description' => 'The tag match conditions that are described in a JSON string. For more information about this parameter, see the **Additional description of the MatchExpressions parameter** section.', - 'type' => 'string', - 'required' => false, - 'example' => '[{"key":"severity","value":"critical","operator":"re"}]', - ], + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable access token authentication.', 'type' => 'boolean', 'required' => false, 'example' => ''], ], [ - 'name' => 'Tags', + 'name' => 'EnableAuthFreeRead', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable authentication-free read.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'AuthFreeReadPolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The list of IP addresses for authentication-free read. CIDR notation is supported. Separate multiple IP addresses with line feeds.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], + ], + [ + 'name' => 'EnableAuthFreeWrite', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable authentication-free write.', 'type' => 'boolean', 'required' => false, 'example' => ''], + ], + [ + 'name' => 'AuthFreeWritePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => ['title' => '', 'description' => 'The list of IP addresses for authentication-free write. CIDR notation is supported. Separate multiple IP addresses with line feeds.', 'type' => 'string', 'required' => false, 'example' => '0.0.0.0/0'], + ], + [ + 'name' => 'PaymentType', 'in' => 'query', - 'style' => 'repeatList', 'schema' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'owner', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'zhangsan', - ], - ], - 'required' => false, - ], + 'title' => '', + 'description' => 'The billing method. Valid values:'."\n" + .'- POSTPAY: Pay-as-you-go based on metric reporting volume.'."\n" + .'- POSTPAY_GB: Pay-as-you-go based on metric write volume.', + 'type' => 'string', + 'enum' => ['POSTPAY', 'POSTPAY_GB'], 'required' => false, - 'maxItems' => 21, + 'example' => 'POSTPAY', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'PrometheusAlertRules' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'Indicates whether the alert rule is enabled. Valid values:'."\n" - ."\n" - .'- 1: The alert rule is enabled.'."\n" - .'- 0: The alert rule is disabled.', - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'Type' => [ - 'description' => 'The type of the alert rule.', - 'type' => 'string', - 'example' => 'Custom', - ], - 'NotifyType' => [ - 'description' => 'The method that is used to send alert notifications. Valid values:'."\n" - ."\n" - .'- ALERT_MANAGER: Alert notifications are sent by Operation Center.'."\n" - .'- DISPATCH_RULE: Alert notifications are', - 'type' => 'string', - 'example' => 'ALERT_MANAGER', - ], - 'Expression' => [ - 'description' => 'The expression of the alert rule.', - 'type' => 'string', - 'example' => '100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\"pod_name\\", \\"$1\\", \\"pod\\", \\"(.*)\\")) by (pod_name))>75', - ], - 'Message' => [ - 'description' => 'The alert message. Tags can be referenced in the {{$labels.xxx}} format.', - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} exceeds 80%. Current value: {{$value}}%'."\n", - ], - 'Duration' => [ - 'description' => 'The duration of the alert. Valid values: 1 to 1440. Unit: minutes.', - 'type' => 'string', - 'example' => '1m', - ], - 'DispatchRuleId' => [ - 'description' => 'The ID of the notification policy. This parameter is returned if the NotifyType parameter is set to `DISPATCH_RULE`.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10282', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule.', - 'type' => 'string', - 'example' => 'Prometheus_Alert', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '3888704', - ], - 'ClusterId' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], - 'Labels' => [ - 'description' => 'The tags of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the tag.', - 'type' => 'string', - 'example' => 'severity', - ], - 'Value' => [ - 'description' => 'The value of the tag associated with the instance.', - 'type' => 'string', - 'example' => 'critical', - ], - ], - ], - ], - 'Annotations' => [ - 'description' => 'The annotations of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The annotation of the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the annotation.', - 'type' => 'string', - 'example' => 'message', - ], - 'Value' => [ - 'description' => 'The value of the annotation.', - 'type' => 'string', - 'example' => 'The CPU utilization of ${{$labels.pod_name}} exceeds 80%. Current value: {{$value}}%'."\n", - ], - ], - ], - ], - 'Tags' => [ - 'description' => 'The tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'example' => 'key', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'example' => 'value', - ], - ], - ], - ], - ], - ], - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n", - 'type' => 'boolean', - 'example' => 'True', - ], + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****'], + 'Data' => ['description' => 'The description of the operation result.', 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Message' => ['description' => 'The message returned for the request.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'Code' => ['description' => 'The status code. A value of 200 indicates success. Other values indicate errors.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], - 'description' => '', + 'example' => '', ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update prometheus instance information', + 'changeSet' => [ + ['createdAt' => '2024-12-13T07:36:21.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-12-05T01:37:43.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-02T01:49:53.000Z', 'description' => 'Request parameters changed'], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertRules\\": [\\n {\\n \\"Status\\": 1,\\n \\"Type\\": \\"自定义\\",\\n \\"NotifyType\\": \\"ALERT_MANAGER\\",\\n \\"Expression\\": \\"100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\\\\\\\\\"pod_name\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"$1\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"pod\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"(.*)\\\\\\\\\\\\\\")) by (pod_name))>75\\",\\n \\"Message\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\",\\n \\"Duration\\": \\"1m\\",\\n \\"DispatchRuleId\\": 10282,\\n \\"AlertName\\": \\"Prometheus_Alert\\",\\n \\"AlertId\\": 3888704,\\n \\"ClusterId\\": \\"c0bad479465464e1d8c1e641b0afb****\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"critical\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%\\"\\n }\\n ],\\n \\"Tags\\": [\\n {\\n \\"Key\\": \\"key\\",\\n \\"Value\\": \\"value\\"\\n }\\n ]\\n }\\n ],\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true\\n}","errorExample":""},{"type":"xml","example":"<ListPrometheusAlertRulesResponse>\\n <PrometheusAlertRules>\\n <Status>1</Status>\\n <NotifyType>ALERT_MANAGER</NotifyType>\\n <Type>自定义</Type>\\n <AlertId>3888704</AlertId>\\n <AlertName>Prometheus_Alert</AlertName>\\n <Message>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Message>\\n <ClusterId>c0bad479465464e1d8c1e641b0afb****</ClusterId>\\n <Expression>100 * (sum(rate(container_cpu_usage_seconds_total[1m])) by (pod_name) / sum(label_replace(kube_pod_container_resource_limits_cpu_cores, \\\\\\"pod_name\\\\\\", \\\\\\"$1\\\\\\", \\\\\\"pod\\\\\\", \\\\\\"(.*)\\\\\\")) by (pod_name))&gt;75</Expression>\\n <DispatchRuleId>10282</DispatchRuleId>\\n <Duration>1m</Duration>\\n <Labels>\\n <Value>critical</Value>\\n <Name>severity</Name>\\n </Labels>\\n <Annotations>\\n <Value>${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%</Value>\\n <Name>message</Name>\\n </Annotations>\\n </PrometheusAlertRules>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n</ListPrometheusAlertRulesResponse>","errorExample":""}]', - 'title' => 'ListPrometheusAlertRules', - 'requestParamsDescription' => '### Additional description of the MatchExpressions parameter'."\n" - .'JSON string example and description'."\n" - ."\n" - .'```'."\n" - .'['."\n" - .'{'."\n" - .' "key":"severity", // The key of the tag. '."\n" - .' "value":"critical", // The value of the tag. '."\n" - .' "operator":"re" // eq: equals to. re: matches a regular expression. '."\n" - .'}'."\n" - .']'."\n" - .'```', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListPrometheusAlertTemplates' => [ - 'methods' => [ - 'post', - 'get', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], + ], ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'UpdatePrometheusIntegration' => [ + 'summary' => 'Modifies the configurations of an exporter that is integrated into a Prometheus instance for Container Service or a Prometheus instance for ECS.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], + ], + [ 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the cluster.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'c0bad479465464e1d8c1e641b0afb****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance. Only a Prometheus instance for Container Service or a Prometheus instance for ECS is supported.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Param', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'The configurations of the exporter. The value is a JSON string.'."\n", 'type' => 'string', 'required' => true, 'example' => '{'."\n" + .' "port": "5554",'."\n" + .' "name": "kafka-test12",'."\n" + .' "kafka_instance": "kafka-test",'."\n" + .' "__label_value": "kafka-test",'."\n" + .' "scrape_interval": 33,'."\n" + .' "metrics_path": "/metrics",'."\n" + .' "__label_key": "kafka-test"'."\n" + .'}'], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => ['description' => 'The exporter ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2893', 'title' => ''], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the integration.'."\n", 'type' => 'string', 'required' => true, 'example' => 'kafka、mysql、redis、snmp、emr、nubela、tidb等。'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', - ], - 'PrometheusAlertTemplates' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Node'."\n", - ], - 'Description' => [ - 'description' => 'The content of the alert notification. Tags can be referenced in the {{$labels.xxx}} format.'."\n", - 'type' => 'string', - 'example' => 'The available memory on node {{ $labels.instance }} is less than 10%. Available memory: {{ $value }}%'."\n", - ], - 'Expression' => [ - 'description' => 'The expression of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10', - ], - 'Version' => [ - 'description' => 'The version of the alert rule.'."\n", - 'type' => 'string', - 'example' => '1.0', - ], - 'Duration' => [ - 'description' => 'The duration of the alert. Valid values: 1 to 1440. Unit: minutes.'."\n", - 'type' => 'string', - 'example' => '1m', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'The available memory on the node is less than 10%'."\n", - ], - 'Labels' => [ - 'description' => 'The tags of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the tag.'."\n", - 'type' => 'string', - 'example' => 'severity', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'warning', - ], - ], - ], - ], - 'Annotations' => [ - 'description' => 'The annotations of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the annotation.'."\n", - 'type' => 'string', - 'example' => 'message', - ], - 'Value' => [ - 'description' => 'The value of the annotation.'."\n", - 'type' => 'string', - 'example' => 'The available memory on node {{ $labels.instance }} is less than 10%. Available memory: {{ $value }}%'."\n", - ], - ], - ], - ], - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'Id of the request'."\n", 'type' => 'string', 'example' => '2DB771C3-D1BB-5363-8A5F-ADB2AF2948DB'], + 'Data' => [ + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'InstanceId' => ['description' => 'The exporter ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '2866', 'title' => ''], + 'InstanceName' => ['title' => '', 'description' => 'The exporter name.'."\n", 'type' => 'string', 'example' => 'inet'], ], + 'title' => '', + 'example' => '', ], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => '查询成功', 'title' => ''], + 'Code' => ['description' => 'The status code or error code.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"9FEA6D00-317F-45E3-9004-7FB8B0B7****\\",\\n \\"PrometheusAlertTemplates\\": [\\n {\\n \\"Type\\": \\"节点\\",\\n \\"Description\\": \\"节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%\\",\\n \\"Expression\\": \\"node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10\\",\\n \\"Version\\": \\"1.0\\",\\n \\"Duration\\": \\"1m\\",\\n \\"AlertName\\": \\"节点内存可用率不足10%\\",\\n \\"Labels\\": [\\n {\\n \\"Name\\": \\"severity\\",\\n \\"Value\\": \\"warning\\"\\n }\\n ],\\n \\"Annotations\\": [\\n {\\n \\"Name\\": \\"message\\",\\n \\"Value\\": \\"节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListPrometheusAlertTemplatesResponse>\\n <RequestId>9FEA6D00-317F-45E3-9004-7FB8B0B7****</RequestId>\\n <PrometheusAlertTemplates>\\n <Type>节点</Type>\\n <Description>节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%</Description>\\n <AlertName>节点内存可用率不足10%</AlertName>\\n <Version>1</Version>\\n <Expression>node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 &lt; 10</Expression>\\n <Duration>1m</Duration>\\n <Labels>\\n <Value>warning</Value>\\n <Name>severity</Name>\\n </Labels>\\n <Annotations>\\n <Value>节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%</Value>\\n <Name>message</Name>\\n </Annotations>\\n </PrometheusAlertTemplates>\\n</ListPrometheusAlertTemplatesResponse>","errorExample":""}]', - 'title' => 'ListPrometheusAlertTemplates', - 'summary' => 'Queries the alert templates of Prometheus Service.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateAlertContact' => [ - 'summary' => 'Creates an alert contact.', - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'IdempotentParameterMismatch', 'errorMessage' => 'The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical.', 'description' => ''], + ], ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。'], + 'title' => 'UpdatePrometheusIntegration', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusIntegration'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2DB771C3-D1BB-5363-8A5F-ADB2AF2948DB\\",\\n \\"Data\\": {\\n \\"InstanceId\\": 2866,\\n \\"InstanceName\\": \\"inet\\"\\n },\\n \\"Message\\": \\"查询成功\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + ], + 'UpdatePrometheusMonitoring' => [ + 'summary' => 'Updates the monitoring configuration of a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - ], + 'deprecated' => true, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'JohnDoe', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'PhoneNum', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile number of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1381111****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.', 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], ], [ - 'name' => 'Email', + 'name' => 'MonitoringName', 'in' => 'query', - 'schema' => [ - 'description' => 'The email address of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'someone@example.com', - ], + 'schema' => ['description' => 'The name of the monitoring configuration.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'podMonitor1', 'title' => ''], ], [ - 'name' => 'DingRobotWebhookUrl', + 'name' => 'Type', 'in' => 'query', - 'schema' => [ - 'description' => 'The webhook URL of the DingTalk chatbot. For more information about how to obtain the URL, see [Configure a DingTalk chatbot to send alert notifications](https://www.alibabacloud.com/help/zh/doc-detail/106247.htm). You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" - ."\n" - .'> Enter `alert` in the custom keyword field of DingTalk chatbot security settings.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', - ], + 'schema' => ['description' => 'The type of the monitoring configuration.'."\n" + .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, customJob, and probe.'."\n" + .'Valid values for a Prometheus instance for ECS: customJob and probe.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'title' => '', 'example' => 'podMonitor'], ], [ - 'name' => 'SystemNoc', - 'in' => 'query', + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => ['description' => 'The monitoring configuration. The value is a YAML string.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => '参见请求参数补充说明。', 'title' => ''], + ], + ], + 'responses' => [ + 200 => [ 'schema' => [ - 'description' => 'Specifies whether the alert contact receives system notifications. Valid values:'."\n" - ."\n" - .'* `true`: The alert contact receives system notifications.'."\n" - .'* `false`: The alert contact does not receive system notifications.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', + 'title' => '', + 'description' => 'The response parameters.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.', 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['description' => 'The result of the operation.', 'type' => 'string', 'title' => '', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.', 'type' => 'string', 'example' => 'message', 'title' => ''], + ], + 'example' => '', ], ], + ], + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'UpdatePrometheusMonitoring', + 'requestParamsDescription' => 'ServiceMonitor example:'."\n" + ."\n" + .'```'."\n" + .'apiVersion: monitoring.coreos.com/v1'."\n" + .'kind: ServiceMonitor'."\n" + .'metadata:'."\n" + .' name: tomcat-demo'."\n" + .' namespace: default'."\n" + .'spec:'."\n" + .' endpoints:'."\n" + .' - interval: 30s'."\n" + .' path: /metrics'."\n" + .' port: tomcat-monitor'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: tomcat'."\n" + .'```'."\n" + ."\n" + .'PodMonitor example:'."\n" + ."\n" + .'```'."\n" + .'apiVersion: "monitoring.coreos.com/v1"'."\n" + .'kind: "PodMonitor"'."\n" + .'metadata:'."\n" + .' name: "podmonitor-demo"'."\n" + .' namespace: "default"'."\n" + .'spec:'."\n" + .' namespaceSelector:'."\n" + .' any: true'."\n" + .' podMetricsEndpoints:'."\n" + .' - interval: "30s"'."\n" + .' path: "/metrics"'."\n" + .' port: "tomcat-monitor"'."\n" + .' selector:'."\n" + .' matchLabels:'."\n" + .' app: "nginx2-exporter"'."\n" + .'```'."\n" + ."\n" + .'CustomJob example:'."\n" + ."\n" + .'```'."\n" + .'scrape_configs:'."\n" + .' - job_name: prometheus1'."\n" + .' honor_timestamps: false'."\n" + .' honor_labels: false'."\n" + .' scheme: http'."\n" + .' metrics_path: /metric'."\n" + .' static_configs:'."\n" + .' - targets:'."\n" + .' - 127.0.0.1:9090'."\n" + .'```'."\n" + ."\n" + .'Probe example:'."\n" + ."\n" + .'```'."\n" + .'apiVersion: monitoring.coreos.com/v1'."\n" + .'kind: Probe'."\n" + .'metadata:'."\n" + .' name: name1-tcp-blackbox # Rule: xxx-{tcp/http/ping}-blackbox'."\n" + .' namespace: arms-prom # Optional.'."\n" + .'spec:'."\n" + .' interval: 30s'."\n" + .' jobName: blackbox'."\n" + .' module: tcp_connect'."\n" + .' prober:'."\n" + .' path: /blackbox/probe'."\n" + .' scheme: http'."\n" + .' url: \'localhost:9335\''."\n" + .' targets:'."\n" + .' staticConfig:'."\n" + .' static:'."\n" + .' - \'arms-prom-admin.arms-prom:9335\''."\n" + .'```', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusMonitoring'], + ], + ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'UpdatePrometheusMonitoringStatus' => [ + 'summary' => 'Updates the status of the monitoring configuration of a Prometheus instance.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], + 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ResourceGroupId', + 'name' => 'ClusterId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-aek2eq4peca****', - ], + 'schema' => ['description' => 'The ID of the Prometheus instance.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', 'title' => ''], + ], + [ + 'name' => 'MonitoringName', + 'in' => 'query', + 'schema' => ['description' => 'The name of the monitoring configuration.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob1', 'title' => ''], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => ['title' => '', 'description' => 'The type of the monitoring configuration. '."\n" + .'Valid values for a Prometheus instance for Container Service: serviceMonitor, podMonitor, and customJob. '."\n" + .'Valid value for a Prometheus instance for ECS: customJob. '."\n" + .'The status of probe cannot be modified.', 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'customJob'], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['title' => 'run, stop', 'description' => 'The status of the monitoring configuration. Valid values: run and stop. The status of Probe cannot be modified.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'run'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response parameters.'."\n", 'type' => 'object', 'properties' => [ - 'ContactId' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'string', - 'example' => '102**', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Data' => ['title' => '', 'description' => 'The result of the operation.'."\n", 'type' => 'string', 'example' => 'success'], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'message', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ContactId\\": \\"102**\\",\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlertContactResponse>\\n\\t<RequestId>E9C9DA3D-10FE-472E-9EEF-2D0A3E41****</RequestId>\\n\\t<ContactId>102**</ContactId>\\n</CreateAlertContactResponse>","errorExample":""}]', - 'title' => 'CreateAlertContact', - 'description' => 'This operation is no longer maintained. To create or modify an alert contact, call the CreateOrUpdateContact operation provided by the new version of the Alert Management module.'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateWebhook' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', 'returnType' => 'synchronous'], + 'title' => 'UpdatePrometheusMonitoringStatus', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusMonitoringStatus'], + ], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + ], + 'UpdateRumApp' => [ + 'summary' => 'Updates a Real User Monitoring (RUM) application.', + 'methods' => ['post'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45426,219 +31331,158 @@ 'operationType' => 'readAndWrite', 'deprecated' => false, 'systemTags' => [ - 'operationType' => 'none', + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211832', + 'abilityTreeNodes' => ['FEATUREarmsRY7LT8'], ], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the contact.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'WebhookAlert', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => true, 'example' => 'b5xxxxs@d8deedfa9bf****', 'title' => ''], ], [ - 'name' => 'Method', + 'name' => 'Description', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request method.'."\n" - ."\n" - .'* `Get`'."\n" - .'* `Post`'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'Post', - ], + 'schema' => ['description' => 'The description of the application.', 'type' => 'string', 'required' => false, 'example' => '测试', 'title' => ''], ], [ - 'name' => 'Url', + 'name' => 'IsSubscribe', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the request **method**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******', - ], + 'schema' => ['description' => 'Specifies whether to add the application to favorites. Valid values:'."\n" + .'- true: Add to favorites.'."\n" + .'- false: Do not add to favorites.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'HttpParams', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters in the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"name":"mike"}]', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'HttpHeaders', + 'name' => 'Nickname', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request header.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"Content-Type":"application/json"}]', - ], + 'schema' => ['description' => 'The alias of the application.', 'type' => 'string', 'required' => false, 'example' => '应用别名。', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Restart', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'Specifies whether to restart the application. Valid values:'."\n" + .'- true: Restart.'."\n" + .'- false: Do not restart.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'Body', + 'name' => 'Stop', 'in' => 'query', - 'schema' => [ - 'description' => 'The notification template that is sent when an alert is triggered. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{ "Alert Name": "{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster Name": "{{ .commonLabels.clustername }} {{ end }}{{if eq " app" .commonLabels._aliyun_arms_involvedObject_kind }}", "Application Name": "{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "Notification Policy": "{{ .dispatchRuleName }}", "Alarm Time": "{{ .startTime }}", "Alert Content": "{{ for .alerts }} {{ .annotations.message }} {{ end }}" }', - ], + 'schema' => ['description' => 'Specifies whether to stop the application. Valid values:'."\n" + .'- true: Stop.'."\n" + .'- false: Do not stop.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], [ - 'name' => 'RecoverBody', + 'name' => 'AutoRestart', 'in' => 'query', - 'schema' => [ - 'description' => 'The notification template that is sent when an alert is resolved. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Alert Name": "{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster Name": "{{ .commonLabels.clustername }} {{ end }}{{if eq " app" .commonLabels._aliyun_arms_involvedObject_kind }}", "Application Name": "{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "Notification Policy": "{{ .dispatchRuleName }}", "Alarm Time": "{{ .startTime }}", "Alert Content": "{{ for .alerts }} {{ .annotations.message }} {{ end }}" }', - ], + 'schema' => ['description' => 'Specifies whether to restart the application the next day. Valid values:'."\n" + .'- true: Restart.'."\n" + .'- false: Do not restart.', 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'ContactId' => [ - 'description' => 'The ID of the contact for webhook alerts.'."\n", - 'type' => 'string', - 'example' => '48716', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], - ], - ], + [ + 'name' => 'ServiceDomainOperationJson', + 'in' => 'query', + 'schema' => ['description' => 'The service domain name settings for the application. You can create, update, or delete service domain name configurations.', 'type' => 'string', 'required' => false, 'example' => '{\\"Op\\":\\"Update\\",\\"Domain\\":\\"example.com\\",\\"Config\\":{\\"Description\\":\\"这是描述bbb\\",\\"Tracing\\":\\"true\\",\\"PropagatorTypes\\":[\\"sw8\\"]}}', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ContactId\\": \\"48716\\",\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateWebhookResponse>\\n <ContactId>48716</ContactId>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n</CreateWebhookResponse>","errorExample":""}]', - 'title' => 'CreateWebhook', - 'summary' => 'Adds a contact for webhook alerts.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateAlertContactGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'BonreeSDKConfigJson', + 'in' => 'query', + 'schema' => ['description' => 'The mobile SDK collection configuration. You can enable or disable collection items by app version.', 'type' => 'string', 'required' => false, 'example' => '{\\"moduleConfig\\":{\\"enable\\":true,\\"defaultConfig\\":{\\"network\\":{\\"enable\\":true},\\"h5\\":{\\"enable\\":true},\\"routechange\\":{\\"enable\\":true},\\"crash\\":{\\"enable\\":true},\\"view\\":{\\"enable\\":true},\\"coollaunch\\":{\\"enable\\":true},\\"hotlaunch\\":{\\"enable\\":true},\\"action\\":{\\"enable\\":true},\\"lagstuck\\":{\\"enable\\":true},\\"lagfps\\":{\\"enable\\":true},\\"statechange\\":{\\"enable\\":true},\\"anr\\":{\\"enable\\":true},\\"customlog\\":{\\"enable\\":true},\\"customevent\\":{\\"enable\\":true},\\"custommetric\\":{\\"enable\\":true}},\\"versionConfigs\\":{\\"1.1.0\\":{\\"useCustom\\":true,\\"customConfig\\":{\\"network\\":{\\"enable\\":true},\\"h5\\":{\\"enable\\":true},\\"routechange\\":{\\"enable\\":true},\\"crash\\":{\\"enable\\":true},\\"view\\":{\\"enable\\":true},\\"coollaunch\\":{\\"enable\\":true},\\"hotlaunch\\":{\\"enable\\":true},\\"action\\":{\\"enable\\":true},\\"lagstuck\\":{\\"enable\\":false},\\"lagfps\\":{\\"enable\\":false},\\"statechange\\":{\\"enable\\":true},\\"anr\\":{\\"enable\\":true},\\"customlog\\":{\\"enable\\":true},\\"customevent\\":{\\"enable\\":true},\\"custommetric\\":{\\"enable\\":true}}},\\"1.2.0\\":{\\"useCustom\\":false,\\"customConfig\\":{}}}}}', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '44428', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', + [ + 'name' => 'RealRegionId', + 'in' => 'query', + 'schema' => ['description' => 'The region where the application is actually connected. This parameter is used only in the China (Shanghai) Finance Cloud scenario.', 'type' => 'string', 'required' => false, 'example' => 'cn-shanghai-finance-1', 'title' => ''], ], - ], - 'parameters' => [ [ - 'name' => 'ContactGroupName', + 'name' => 'BackendServiceTraceRegion', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TestGroup', - ], + 'schema' => ['description' => 'The region where the backend application is deployed. This parameter is used in end-to-end tracing scenarios.', 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ContactIds', + 'name' => 'AppConfig', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of contacts in the contact group. Separate multiple contact IDs with spaces. You can call the SearchAlertContact operation to query the contact IDs. For more information, see [SearchAlertContact](~~130703~~).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '12* 23* 34*', - ], + 'schema' => ['description' => 'The legacy application configuration in JSON format. This parameter is deprecated.', 'type' => 'string', 'required' => false, 'example' => '{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'WebSDKConfigJson', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['type' => 'string', 'description' => '', 'required' => false, 'title' => '', 'example' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'ContactGroupId' => [ - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'string', - 'example' => '446*', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '70675725-8F11-4817-8106-CFE0AD71****', + 'RequestId' => ['title' => '', 'description' => 'Id of the request', 'type' => 'string', 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****'], + 'Code' => ['description' => 'The status code. A value of 200 indicates success.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the update was successful. Valid values:'."\n" + ."\n" + .'- `true`: Successful.'."\n" + .'- `false`: Failed.', 'type' => 'string', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the call failed.', 'type' => 'string', 'example' => 'message', 'title' => ''], + 'HttpStatusCode' => ['description' => 'The HTTP status code.', 'type' => 'string', 'example' => '200', 'title' => ''], + 'Data' => [ + 'description' => 'The details of the response.', + 'type' => 'object', + 'properties' => [ + 'Config' => ['description' => 'The user configuration. This is a reserved field.', 'type' => 'string', 'example' => '用户配置，保留字段。', 'title' => ''], + 'Usage' => ['description' => 'The usage, in bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '10000', 'title' => ''], + 'Limit' => ['description' => 'The quota limit, in bytes.', 'type' => 'integer', 'format' => 'int32', 'example' => '100000', 'title' => ''], + 'Limited' => ['description' => 'Indicates whether the quota is exceeded. Valid values:'."\n" + .'- true: Exceeded.'."\n" + .'- false: Not exceeded.', 'type' => 'boolean', 'example' => 'true', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], - 'description' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"ContactGroupId\\": \\"446*\\",\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateAlertContactGroupResponse>\\n\\t<ContactGroupId>446*</ContactGroupId>\\n\\t<RequestId>70675725-8F11-4817-8106-CFE0AD71****</RequestId>\\n</CreateAlertContactGroupResponse>","errorExample":""}]', - 'title' => 'CreateAlertContactGroup', - 'summary' => 'Creates an alert contact group.', - 'description' => 'The current API operation is no longer maintained. Call the CreateOrUpdateContactGroup operation of the new Alert Management module to create or modify alert contact groups.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'CreateDispatchRule' => [ - 'methods' => [ - 'post', - 'get', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'Update RUM application', + 'description' => 'Real User Monitoring is currently available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.', + 'changeSet' => [ + ['createdAt' => '2025-09-16T15:18:07.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2025-02-17T02:00:51.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-19T11:25:10.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-09-02T10:52:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-07-03T08:00:38.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [ + [ + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateRumApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"Code\\": \\"200\\",\\n \\"Success\\": \\"true\\",\\n \\"Message\\": \\"message\\",\\n \\"HttpStatusCode\\": \\"200\\",\\n \\"Data\\": {\\n \\"Config\\": \\"用户配置，保留字段。\\",\\n \\"Usage\\": 10000,\\n \\"Limit\\": 100000,\\n \\"Limited\\": true\\n }\\n}","type":"json"}]', + ], + 'UpdateRumFileStatus' => [ + 'summary' => 'Updates the status of a Real User Monitoring (RUM) file. You can call this operation after the RUM file is uploaded.', + 'methods' => ['post', 'get'], + 'schemes' => ['https'], 'security' => [ [ 'AK' => [], @@ -45646,670 +31490,653 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '44431', - 'abilityTreeNodes' => [ - 'FEATUREarmsVBCGEE', - ], - ], + 'systemTags' => ['operationType' => 'update', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'DispatchRule', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The dispatch rule configuration. The value is a JSON string. For more information about this parameter, see the following **additional information about the DispatchRule parameter**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "system": false, "ruleid": 10282, "name": "Prometheus Alert", "labelMatchExpressionGrid": { "labelMatchExpressionGroups": [ { "labelMatchExpressions": [ { "key": "_aliyun_arms_involvedObject_kind", "value": "app", "operator": "eq" } ] } ] }, "dispatchType": "CREATE_ALERT/DISCARD_ALERT", "isRecover": true, "groupRules": [ { "groupId": 1, "groupingFields": [ "alertname" ], "groupWait": 10, "groupInterval": 15, "repeatInterval": 20 } ], "notifyRules": [ { "notifyObjects": [ { "notifyType": "ARMS_CONTACT", "name": "JohnDoe", "notifyObjectId": 1 }, { "notifyType": "ARMS_CONTACT_GROUP", "name": "JohnDoe_group", "notifyObjectId": 2 } ], "notifyChannels":["dingTalk","wechat","webhook","email"] }, ], }', - ], + 'schema' => ['description' => 'The application ID.', 'type' => 'string', 'required' => false, 'example' => 'atc8xxxx'."\n" + .'cf@d8deedfa9bf****', 'title' => ''], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => ['description' => 'The version number of the file.', 'type' => 'string', 'required' => false, 'example' => '1.0.0', 'title' => ''], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => ['description' => 'The unique ID of the file. If you do not set this parameter, the system automatically sets a UUID for you.', 'type' => 'string', 'required' => false, 'example' => 'MS4wLjAtbWFpbi4wZjM0NzRlOSxxxxxx', 'title' => ''], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => ['description' => 'The file name.', 'type' => 'string', 'required' => false, 'example' => 'test.js.map', 'title' => ''], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => ['description' => 'The size of the file. Unit: bytes.', 'type' => 'string', 'required' => false, 'example' => '20', 'title' => ''], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => ['description' => 'The status of the file. Valid values: SUCCESS and INIT.', 'type' => 'string', 'required' => false, 'example' => 'SUCCESS', 'title' => ''], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The region ID.', 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => '', + 'description' => 'Schema of Response', 'type' => 'object', 'properties' => [ - 'DispatchRuleId' => [ - 'description' => 'The ID of the dispatch policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10413', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], + 'RequestId' => ['title' => '', 'description' => 'The request ID.', 'type' => 'string', 'example' => '626037F5-FDEB-45B0-804C-B3C92797****'], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"DispatchRuleId\\": 10413,\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\"\\n}","errorExample":""},{"type":"xml","example":"<CreateDispatchRuleResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <DispatchRuleId>10413</DispatchRuleId>\\n</CreateDispatchRuleResponse>","errorExample":""}]', - 'title' => 'CreateDispatchRule', - 'summary' => 'Creates a dispatch policy.', - 'requestParamsDescription' => '## Additional information about the **DispatchRule** parameter'."\n" - ."\n" - .'**JSON string example and description**'."\n" - ."\n" - .'```'."\n" - ."\n" - .'{'."\n" - .' "system": false, // Specifies whether the dispatch rule is editable. Valid values: true: not editable. false: editable. '."\n" - .' "ruleid": 10282, // The ID of the dispatch rule. '."\n" - .' "name": "Prometheus Alert", // The name of the dispatch policy. '."\n" - .' "labelMatchExpressionGrid": {'."\n" - .' "labelMatchExpressionGroups": [ // Sets the dispatch rule. '."\n" - .' {'."\n" - .' "labelMatchExpressions": ['."\n" - .' {'."\n" - .' "key": "_aliyun_arms_involvedObject_kind", // The key of the tag of the dispatch rule. For more information, see the next section. '."\n" - .' "value": "app", // The value of the tag. '."\n" - .' "operator": "eq" // The operator used in the dispatch rule. Valid values: eq: equals to. re: matches a regular expression. '."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "dispatchType": "CREATE_ALERT/DISCARD_ALERT", // The alert handling method. Valid values: CREATE_ALERT: generates an alert. DISCARD_ALERT: discards the alert event and generates no alert. '."\n" - .' "isRecover": true, // Specifies whether to send the restored alert. Valid values: true: sends the alert. false: does not send the alert. '."\n" - .' "groupRules": [ // Sets the event group. '."\n" - .' {'."\n" - .' "groupId": 1, // The ID of the group. '."\n" - .' "groupingFields": [ // The fields that are used to group events. Events with the same field content are assigned to a group. Alerts with the same specified grouping field are sent to the handler in separate notifications. '."\n" - .' "alertname"'."\n" - .' ],'."\n" - .' "groupWait": 10, // The duration for which the system waits after the first alert is sent. After the duration, all alerts are sent in a single notification to the handler. '."\n" - .' "groupInterval": 15, // The grouping interval. During the silence period of repeated alerts, if new alerts are generated, they will be sent after the group waiting time. '."\n" - .' "repeatInterval": 20 // The silence period of repeated alerts. All alerts are repeatedly sent at specified intervals until the alerts are cleared. '."\n" - .' }'."\n" - .' ],'."\n" - .' "notifyRules": [ // Sets the notification rule. '."\n" - .' {'."\n" - .' "notifyObjects": ['."\n" - .' {'."\n" - .' "notifyType": "ARMS_CONTACT", // The type of the alert contact. Valid values: ARMS_CONTACT: contact. ARMS_CONTACT_GROUP: contact group. '."\n" - .' "name": "JohnDoe", // The name of the contact or contact group. '."\n" - .' "notifyObjectId": 1 // The ID of the contact or contact group. '."\n" - .' },'."\n" - .' {'."\n" - .' "notifyType": "ARMS_CONTACT_GROUP",'."\n" - .' "name": "JohnDoe_group",'."\n" - .' "notifyObjectId": 2'."\n" - .' }'."\n" - .' ],'."\n" - .' "notifyChannels":["dingTalk","wechat","webhook","email"] // The notification method. Valid values: dingTalk, sms, webhook, email, and wechat. '."\n" - .' },'."\n" - .' ],'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'**Enumerated keys of the tag of the dispatch rule**'."\n" - ."\n" - .'* `_aliyun_arms_userid`: user ID'."\n" - .'* `_aliyun_arms_involvedObject_kind`: type of the associated object'."\n" - .'* `_aliyun_arms_involvedObject_id`: ID of the associated object'."\n" - .'* `_aliyun_arms_involvedObject_name`: name of the associated object'."\n" - .'* `_aliyun_arms_alert_name`: alert name'."\n" - .'* `_aliyun_arms_alert_rule_id`: alert rule ID'."\n" - .'* `_aliyun_arms_alert_type`: alert type'."\n" - .'* `_aliyun_arms_alert_level`: alert severity'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListActivatedAlerts' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'title' => 'UpdateRumFileStatus', + 'description' => 'Real User Monitoring (RUM) is available only in the China (Hangzhou), Singapore, and US (Silicon Valley) regions. Select the correct endpoint.', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [], ], + 'ramActions' => [], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\"\\n}","type":"json"}]', + ], + 'UpdateTimingSyntheticTask' => [ + 'summary' => 'Updates a scheduled synthetic test task.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'read', + 'operationType' => 'write', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '44476', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', - ], - ], + 'systemTags' => ['operationType' => 'create'], 'parameters' => [ [ - 'name' => 'Filter', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The filter condition in the `{"key":"value"}`format. You must specify the `key` and `value` of the filter condition.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '{"alertname":"Container CPU usage is greater than 80%"}', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'TaskId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou ', - ], + 'schema' => ['description' => 'The ID of the synthetic monitoring task.'."\n", 'type' => 'string', 'required' => false, 'example' => '5308a2691f59422c8c3b7aeccxxxxxxx', 'title' => ''], ], [ - 'name' => 'CurrentPage', + 'name' => 'Name', 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '1', - ], + 'schema' => ['description' => 'The name of the task.'."\n", 'type' => 'string', 'required' => false, 'example' => '拨测任务', 'title' => ''], ], [ - 'name' => 'PageSize', + 'name' => 'MonitorConf', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: `10`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'docRequired' => true, - 'example' => '10', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ + 'description' => 'The monitoring configurations.'."\n", 'type' => 'object', 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'BDB74B8F-4123-482A-ABB7-7F440349****', + 'NetICMP' => [ + 'description' => 'The parameters of the ICMP synthetic test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The IP address or domain name of the destination host. The value cannot contain port numbers, protocol headers, or request paths.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], + 'Interval' => ['description' => 'The interval at which ICMP packets are sent. Unit: milliseconds. Minimum value: 200. Maximum value: 10000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], + 'PackageNum' => ['description' => 'The number of ICMP packets that are sent. Minimum value: 1. Maximum value: 50. Default value: 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], + 'PackageSize' => ['description' => 'The size of each ICMP packet. Unit: bytes. Valid values: 32, 64, 128, 256, 512, 1024, 1080, and 1450.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '32', 'title' => ''], + 'SplitPackage' => ['description' => 'Specifies whether to split ICMP packets. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true'."\n", 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for the ICMP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'TracertEnable' => ['description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TracertNumMax' => ['description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'TracertTimeout' => ['description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Page' => [ - 'description' => 'The struct returned.'."\n", + 'NetTCP' => [ + 'description' => 'The parameters of the TCP synthetic test.'."\n", 'type' => 'object', 'properties' => [ - 'PageSize' => [ - 'description' => 'The number of entries returned per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '20', + 'TargetUrl' => ['description' => 'The IP address of the destination host.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.0.1:8888', 'title' => ''], + 'ConnectTimes' => ['description' => 'The number of TCP connections that are established. Minimum value: 1. Maximum value: 16. Default value: 4.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], + 'Interval' => ['description' => 'The interval at which TCP connections are established. Unit: milliseconds. Minimum value: 200. Maximum value: 10000. Default value: 200.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '300', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for the TCP synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 20000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + 'TracertEnable' => ['description' => 'Specifies whether to enable the tracert command. Default value: true.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TracertNumMax' => ['description' => 'The maximum number of hops for the tracert command. Minimum value: 1. Maximum value: 128. Default value: 20.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '20', 'title' => ''], + 'TracertTimeout' => ['description' => 'The timeout period of the tracert command. Unit: milliseconds. Minimum value: 1000. Maximum value: 300000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'NetDNS' => [ + 'description' => 'The parameters of the DNS synthetic test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], + 'Dig' => ['description' => 'Specifies whether to use the dig command to display the data. Valid values: 0: no. 1: yes.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'DnsServerIpType' => ['description' => 'The IP version of the DNS server. Valid values: 0: IPv4. 1: IPv6. 2: A version is automatically selected. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'NsServer' => ['description' => 'The IP address of the DNS server. Default value: 114.114.114.114.'."\n", 'type' => 'string', 'required' => false, 'example' => '114.114.114.114', 'title' => ''], + 'QueryMethod' => ['description' => 'The DNS query method. Valid values: 0: recursive. 1: iterative. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period for the DNS synthetic test. Unit: milliseconds. Minimum value: 1000. Maximum value: 45000. Default value: 5000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '1000', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'ApiHTTP' => [ + 'description' => 'The parameters of the HTTP(S) synthetic test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The URL or request path for synthetic monitoring.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://********', 'title' => ''], + 'Method' => ['description' => 'The request method. Valid values:'."\n" + ."\n" + .'* POST'."\n" + .'* GET'."\n", 'type' => 'string', 'required' => false, 'example' => 'POST', 'title' => ''], + 'RequestHeaders' => [ + 'description' => 'The custom header field.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'description' => 'The HTTP request header.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', + 'RequestBody' => [ + 'description' => 'The HTTP request body.'."\n", + 'type' => 'object', + 'properties' => [ + 'Content' => ['description' => 'The content of the request body. Format: JSON string. The parameter is required if the Type parameter is set to text/plain, application/json, application/xml, or text/html. Format: JSON string.'."\n", 'type' => 'string', 'required' => false, 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'title' => ''], + 'Type' => ['description' => 'The type of the request body. Valid values: text/plain, application/json, application/x-www-form-urlencoded, multipart/form-data, application/xml, and text/html.'."\n", 'type' => 'string', 'required' => false, 'example' => 'application/json', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Page' => [ - 'description' => 'The page number of the returned page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', + 'ConnectTimeout' => ['description' => 'The connection timeout period. Unit: milliseconds. Default value: 5000. Minimum value: 1000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'Timeout' => ['description' => 'The timeout period. Unit: milliseconds. Default value: 10000. Minimum value: 1000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'CheckCert' => ['description' => 'Specifies whether to verify the certificate. Default value: false.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'ProtocolAlpnProtocol' => ['description' => 'The ALPN protocol version. You can configure this parameter when you perform an HTTPS synthetic test on a WAP mobile client. Valid values:'."\n" + ."\n" + .'0: default'."\n" + ."\n" + .'1-http/1.1'."\n" + ."\n" + .'2-h2'."\n" + ."\n" + .'3: disables the ALPN protocol'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'Website' => [ + 'description' => 'The parameters of the website speed measurement.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The URL of the website.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://********', 'title' => ''], + 'AutomaticScrolling' => ['description' => 'Specifies whether to automatically scroll up and down the screen to load a page. Valid values: 0: no. 1: yes. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'CustomHeader' => ['description' => 'Specifies whether to create a custom header. Valid values: 0: no. 1: The first packet is modified. 2: All packets are modified. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The custom header. Format: JSON map.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'The custom header. Format: JSON map.'."\n", 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'title' => ''], + 'title' => '', + 'example' => '', ], - 'Alerts' => [ - 'description' => 'The alerts that have been triggered.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the alert. Valid values:'."\n" - ."\n" - .'* `Active`'."\n" - .'* `Inhibited`'."\n" - .'* `Silenced`'."\n" - .'* `Resolved`'."\n", - 'type' => 'string', - 'example' => 'Active', - ], - 'Severity' => [ - 'description' => 'The level of the alert. Valid values:'."\n" - ."\n" - .'* `critical`'."\n" - .'* `error`'."\n" - .'* `warn`'."\n" - .'* `page`'."\n", - 'type' => 'string', - 'example' => 'critical', - ], - 'IntegrationName' => [ - 'description' => 'The name of the object that is associated with the alert.'."\n", - 'type' => 'string', - 'example' => 'testphp2', - ], - 'CreateTime' => [ - 'description' => 'The timestamp when the alert rule was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1616466300000', - ], - 'Message' => [ - 'description' => 'The description of the alert.'."\n", - 'type' => 'string', - 'example' => 'Alarm name: PodRestart_testphp2,\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%', - ], - 'AlertType' => [ - 'description' => 'The type of the alert.'."\n", - 'type' => 'string', - 'example' => 'PROMETHEUS_MONITORING_ALERT_RULE', - ], - 'InvolvedObjectName' => [ - 'description' => 'The name of the service integration that generated the alert.'."\n", - 'type' => 'string', - 'example' => 'Test integration-prometheus', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'Container CPU usage is greater than 80%', - ], - 'Count' => [ - 'description' => 'The number of times that the alert event was received.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '598', - ], - 'ExpandFields' => [ - 'description' => 'The extended fields that indicate the following tags:'."\n" - ."\n" - .'* The tags that are carried in the metrics of the alert rule expression.'."\n" - .'* The tags that are created based on the alert rule.'."\n" - .'* The default tags of Application Real-Time Monitoring Service (ARMS).'."\n", - 'type' => 'object', - 'example' => '', - ], - 'EndsAt' => [ - 'description' => 'The timestamp when the alert was ended.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1616502540000', - ], - 'InvolvedObjectKind' => [ - 'description' => 'The type of the object that is associated with the alert.'."\n", - 'type' => 'string', - 'example' => 'cluster', - ], - 'IntegrationType' => [ - 'description' => 'The type of the service integration that generated the alert.'."\n", - 'type' => 'string', - 'example' => 'PROMETHEUS', - ], - 'StartsAt' => [ - 'description' => 'The timestamp when the alert was generated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1616466300000', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => '3888704', - ], - 'DispatchRules' => [ - 'description' => 'The notification policies.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RuleId' => [ - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '7021', - ], - 'RuleName' => [ - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'NotificationPolicy1', - ], - ], - ], - ], - ], - ], + 'DisableCache' => ['description' => 'Specifies whether to disable the cache. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'DisableCompression' => ['description' => 'Specifies whether to accept compressed files based on the HTTP Accept-Encoding request header. Valid values: 0: no. 1: yes. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'FilterInvalidIP' => ['description' => 'Specifies whether to exclude invalid IP addresses. Valid values:'."\n" + ."\n" + .'* 1: no'."\n" + .'* 0: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreCertificateError' => ['description' => 'Specifies whether to ignore SSL certificate errors during browsing. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 5000. Maximum value: 300000. Default value: 40000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '20000', 'title' => ''], + 'Redirection' => ['description' => 'Specifies whether to continue browsing after redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'SlowElementThreshold' => ['description' => 'The time threshold that is used to define a slow element. Unit: milliseconds. Default value: 5000. Minimum value: 1. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'WaitCompletionTime' => ['description' => 'The maximum waiting time. Unit: milliseconds. Default value: 5000. Minimum value: 5000. Maximum value: 300000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'VerifyStringBlacklist' => ['description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is in the blacklist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => 'error', 'title' => ''], + 'VerifyStringWhitelist' => ['description' => 'An arbitrary string in the source code of the page for verification. If the source code returned by the client contains a string that is not in the whitelist, the 650 error code is reported, which indicates that the string fails to be verified. Separate multiple strings with vertical bars (|).'."\n", 'type' => 'string', 'required' => false, 'example' => 'success', 'title' => ''], + 'ElementBlacklist' => ['description' => 'The elements not to be loaded in the page loading process.'."\n", 'type' => 'string', 'required' => false, 'example' => 'a.jpg', 'title' => ''], + 'DNSHijackWhitelist' => ['description' => 'If the IP address or CNAME record resolved from a domain name is not included in the DNS whitelist, you cannot access the domain name, or an IP address that belongs to a different domain name is returned. If the IP address or CNAME record is included in the DNS whitelist, DNS hijacking does not occur.'."\n" + ."\n" + .'Format: \\<domain name>:\\<objects>. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + 'PageTamper' => ['description' => 'Elements that are not included in the whitelist and appear on the page are manipulated. These elements can be pop-up ads, floating ads, and page redirection.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', 'title' => ''], + 'FlowHijackJumpTimes' => ['description' => 'The total number of elements on the page.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'FlowHijackLogo' => ['description' => 'The keyword that is used to identify hijacking. Asterisks (\\*) are allowed.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'FileDownload' => [ + 'description' => 'The parameters of file downloading.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The URL that is used to download the file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png', 'title' => ''], + 'DownloadKernel' => ['description' => 'The kernel type. Valid values:'."\n" + ."\n" + .'* 1: curl'."\n" + .'* 0: WinInet'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'QuickProtocol' => ['description' => 'The QUIC protocol type. Valid values:'."\n" + ."\n" + .'* 1: HTTP/1'."\n" + .'* 2: HTTP/2'."\n" + .'* 3: http3'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'ConnectionTimeout' => ['description' => 'Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 5000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '5000', 'title' => ''], + 'MonitorTimeout' => ['description' => 'The monitoring timeout period. Unit: milliseconds. Minimum value: 1000. Maximum value: 120000. Default value: 60000.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '60000', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The content of the custom request header. Format: JSON map.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'description' => 'The content of the custom request header. Format: JSON map.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], + 'IgnoreCertificateStatusError' => ['description' => 'Specifies whether to ignore certificate status errors. 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreCertificateUntrustworthyError' => ['description' => 'Specifies whether to ignore certificate incredibility. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreInvalidHostError' => ['description' => 'Specifies whether to ignore host invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Redirection' => ['description' => 'Specifies whether to support redirection. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'TransmissionSize' => ['description' => 'The maximum file size of a single transfer. Unit: KB. Minimum value: 1. Maximum value: 20480. Valid values: 2048.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => false, 'example' => '2048', 'title' => ''], + 'IgnoreCertificateCanceledError' => ['description' => 'Specifies whether to ignore certificate revocation errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreCertificateAuthError' => ['description' => 'Specifies whether to ignore CA certificate authentication errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreCertificateOutOfDateError' => ['description' => 'Specifies whether to ignore certificate invalidity. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IgnoreCertificateUsingError' => ['description' => 'Specifies whether to ignore certificate usage errors. Valid values: 0: no. 1: yes. Default value: 1.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'VerifyWay' => ['description' => 'The verification method. Valid values:'."\n" + ."\n" + .'* 0: no verification'."\n" + .'* 1: string verification'."\n" + .'* 2: MD5 verification'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'ValidateKeywords' => ['description' => 'The keyword that is used in verification.'."\n", 'type' => 'string', 'required' => false, 'example' => 'aliyun', 'title' => ''], + 'WhiteList' => ['description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], ], + 'required' => false, + 'title' => '', + 'example' => '', ], - 'Message' => [ - 'type' => 'string', + 'Stream' => [ + 'description' => 'The parameters of the streaming-media synthetic test.'."\n", + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => ['description' => 'The resource URL of the streaming media.'."\n", 'type' => 'string', 'required' => false, 'example' => 'http://www.aliyun.com/stream/test.mp4', 'title' => ''], + 'StreamType' => ['description' => 'Specifies whether the resource is a video or audio. Valid values: 0: video. 1: audio.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'StreamMonitorTimeout' => ['description' => 'The monitoring duration. Unit: seconds. Maximum and default value: 60.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '30', 'title' => ''], + 'StreamAddressType' => ['description' => 'The address type of the resource. Valid values:'."\n" + ."\n" + .'* 1: resource URL.'."\n" + .'* 0: page URL. Default value: 0.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'PlayerType' => ['description' => 'The player. Default value: 12. Valid values:'."\n" + ."\n" + .'* 12: VLC'."\n" + .'* 2: Flash Player'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '2', 'title' => ''], + 'CustomHeaderContent' => [ + 'description' => 'The custom header. Format: JSON map.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', 'description' => 'The custom header. Format: JSON map.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'WhiteList' => ['description' => 'The whitelisted objects that are used to avoid DNS hijacking. The objects can be IP addresses, wildcard mask, subnet mask, or CNAME records. Separate multiple objects with vertical bars (|). Example: www.aliyun.com:203.0.3.55|203.3.44.67. It indicates that all IP addresses that belong to the www.aliyun.com domain name except 203.0.3.55 and 203.3.44.67 are hijacked.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"BDB74B8F-4123-482A-ABB7-7F440349****\\",\\n \\"Page\\": {\\n \\"PageSize\\": 20,\\n \\"Total\\": 5,\\n \\"Page\\": 1,\\n \\"Alerts\\": [\\n {\\n \\"Status\\": \\"Active\\",\\n \\"Severity\\": \\"critical\\",\\n \\"IntegrationName\\": \\"testphp2\\",\\n \\"CreateTime\\": 1616466300000,\\n \\"Message\\": \\"报警名称：PodRestart_testphp2，\\\\\\\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%\\",\\n \\"AlertType\\": \\"ARMS-Prometheus监控\\",\\n \\"InvolvedObjectName\\": \\"测试集成-prometheus\\",\\n \\"AlertName\\": \\"容器CPU使用率大于80%\\",\\n \\"Count\\": 598,\\n \\"ExpandFields\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"EndsAt\\": 1616502540000,\\n \\"InvolvedObjectKind\\": \\"cluster\\",\\n \\"IntegrationType\\": \\"PROMETHEUS\\",\\n \\"StartsAt\\": 1616466300000,\\n \\"AlertId\\": \\"3888704\\",\\n \\"DispatchRules\\": [\\n {\\n \\"RuleId\\": 7021,\\n \\"RuleName\\": \\"容器CPU使用率大于80%的通知策略\\"\\n }\\n ]\\n }\\n ]\\n },\\n \\"Message\\": \\"CurrentPage is mandatory for this action.\\"\\n}","errorExample":""},{"type":"xml","example":"<ListActivatedAlertsResponse>\\n<RequestId>BDB74B8F-4123-482A-ABB7-7F440349****</RequestId>\\n<Page>\\n <PageSize>20</PageSize>\\n <Total>5</Total>\\n <Page>1</Page>\\n <Alerts>\\n <Status>Active</Status>\\n <AlertName>容器CPU使用率大于80%</AlertName>\\n <Message>报警名称：PodRestart_testphp2，\\\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%</Message>\\n <InvolvedObjectKind>cluster</InvolvedObjectKind>\\n <CreateTime>1616466300000</CreateTime>\\n <Severity>critical</Severity>\\n <Count>598</Count>\\n <ExpandFields> \\"severity\\": \\"critical\\", \\"_aliyun_arms_alert_level\\": \\"ERROR\\", \\"pod\\": \\"night-test-group-1-1-5f5d6f4d84-pszns\\", \\"_aliyun_arms_alert_type\\": \\"101\\", \\"_aliyun_arms_integration_name\\": \\"测试集成-prometheus\\", \\"alertname\\": \\"PodRestart_jiubiantestphp2\\", \\"_aliyun_arms_userid\\": \\"1131971649496228\\", \\"_aliyun_arms_involvedObject_name\\": \\"jiubiantestphp2\\", \\"_aliyun_arms_involvedObject_id\\": \\"ccafb2763cfa7415eb2e2a60a74b1f825\\", \\"_aliyun_arms_region_id\\": \\"cn-beijing\\", \\"_aliyun_arms_involvedObject_kind\\": \\"cluster\\", \\"_aliyun_arms_product_type\\": \\"PROMETHEUS\\", \\"namespace\\": \\"default\\", \\"_aliyun_arms_integration_id\\": \\"80\\", \\"_aliyun_arms_involvedObject_type\\": \\"ManagedKubernetes\\", \\"_aliyun_arms_alert_rule_id\\": \\"3612229\\"</ExpandFields>\\n <InvolvedObjectName>测试集成-prometheus</InvolvedObjectName>\\n <EndsAt>1616502540000</EndsAt>\\n <AlertType>ARMS-Prometheus监控</AlertType>\\n <IntegrationName>testphp2</IntegrationName>\\n <AlertId>3888704</AlertId>\\n <StartsAt>1616466300000</StartsAt>\\n <IntegrationType>PROMETHEUS</IntegrationType>\\n <DispatchRules>\\n <RuleId>7021</RuleId>\\n <RuleName>容器CPU使用率大于80%的通知策略</RuleName>\\n </DispatchRules>\\n </Alerts>\\n</Page>\\n</ListActivatedAlertsResponse>","errorExample":""}]', - 'title' => 'ListActivatedAlerts', - 'summary' => 'Queries the alerts that have been triggered.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ImportAppAlertRules' => [ - 'summary' => 'Creates an alert rule based on an alert template.', - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'TemplateAlertId', + 'name' => 'Monitors', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the alert template. You must set at least one of the **TemplateAlertId** and **TemplageAlertConfig** parameters. If you set both parameters, the **TemplateAlertId** parameter prevails.'."\n", - 'type' => 'string', + 'description' => 'The list of monitoring points.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'CityCode' => ['description' => 'The city code.'."\n", 'type' => 'string', 'required' => false, 'example' => '100001', 'title' => ''], + 'OperatorCode' => ['description' => 'The carrier code.'."\n", 'type' => 'string', 'required' => false, 'example' => '1', 'title' => ''], + 'ClientType' => ['description' => 'The client type of the monitoring point. Valid values: 1: data center. 2: Internet. 3: mobile device. 4: ECS instance.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '4', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => '324324234', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'Pids', + 'name' => 'Frequency', 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifiers (PIDs) of the applications associated with the alert rule. The value must be a JSON array. For more information about how to obtain the PID, see [Obtain the PID of an application](~~186100#section-bkl-3j6-ezg~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '["atc889zkcf@d8deedfa9bfxxxx", "acd129bfcf@d5daebfa6cdxxxx"]', - ], + 'schema' => ['description' => 'The detection frequency. Valid values: 1m, 5m, 10m, 15m, 20m, 30m, 1h, 2h, 3h, 4h, 6h, 8h, 12h, and 24h.'."\n", 'type' => 'string', 'required' => false, 'example' => '5m', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'CustomPeriod', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The ID of the region where the associated applications reside.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + 'description' => 'The custom cycle.'."\n", + 'type' => 'object', + 'properties' => [ + 'EndHour' => ['description' => 'The hour at which the test ends. Valid values: 0 to 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '22', 'title' => ''], + 'StartHour' => ['description' => 'The hour at which the test starts. Valid values: 0 to 24.'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '14', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'ContactGroupIds', + 'name' => 'CommonSetting', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'The IDs of the alert contact groups. The value must be a JSON array.'."\n", - 'type' => 'string', + 'description' => 'The general settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'The list of hosts.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => 'The custom host settings.'."\n", + 'type' => 'object', + 'properties' => [ + 'Domain' => ['description' => 'The domain name.'."\n", 'type' => 'string', 'required' => false, 'example' => 'www.aliyun.com', 'title' => ''], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4'."\n" + .'* 2: IPv6'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'Ips' => [ + 'description' => 'The list of IP addresses.'."\n", + 'type' => 'array', + 'items' => ['description' => 'The IP address.'."\n", 'type' => 'string', 'required' => false, 'example' => '127.0.0.1', 'title' => ''], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'SelectType' => ['description' => 'The selection mode. Valid values:'."\n" + ."\n" + .'* 0: random'."\n" + .'* 1: polling'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'IpType' => ['description' => 'The IP version. Valid values:'."\n" + ."\n" + .'* 0: A version is automatically selected.'."\n" + .'* 1: IPv4'."\n" + .'* 2: IPv6'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'MonitorSamples' => ['description' => 'Specifies whether to evenly distribute monitoring samples. Valid values:'."\n" + ."\n" + .'* 0: no'."\n" + .'* 1: yes'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '0', 'title' => ''], + 'IsOpenTrace' => ['description' => 'Specifies whether to enable tracing.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'true', 'title' => ''], + 'TraceClientType' => ['description' => 'The type of the client for tracing. Valid values:'."\n" + ."\n" + .'* 0: ARMS agent'."\n" + .'* 1: OpenTelemetry'."\n" + .'* 2: Jaeger'."\n", 'type' => 'integer', 'format' => 'int32', 'required' => false, 'example' => '1', 'title' => ''], + 'XtraceRegion' => ['description' => 'The region to which trace data is reported.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'CustomVPCSetting' => [ + 'description' => 'The information about the virtual private cloud (VPC). If the destination URL is an Alibaba Cloud internal endpoint, you need to configure a VPC.'."\n", + 'type' => 'object', + 'properties' => [ + 'RegionId' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], + 'VpcId' => ['description' => 'VPC ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vpc-bp15bjtubjytclwxxxxxx', 'title' => ''], + 'VSwitchId' => ['description' => 'The vSwitch ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'vsw-2zevek6r3mpny7wxxxxxv', 'title' => ''], + 'SecureGroupId' => ['description' => 'The ID of the security group to which the client belongs. The security group specifies the inbound and outbound rules of the client for the VPC. You need to allow the security group to which the client belongs to access the security group to which the VPC belongs. Otherwise, the client cannot access resources in the VPC.'."\n", 'type' => 'string', 'required' => false, 'example' => 'sg-xxxxxxxx', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + 'CustomPrometheusSetting' => [ + 'description' => 'The reserved parameters.'."\n", + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => 'The reserved parameters.'."\n", + 'type' => 'object', + 'required' => false, + 'additionalProperties' => ['type' => 'string', 'description' => 'The reserved parameters.'."\n", 'example' => '保留字段。', 'title' => ''], + 'title' => '', + 'example' => '', + ], + 'PrometheusClusterId' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '保留字段。', 'title' => ''], + 'PrometheusClusterRegion' => ['description' => 'A reserved parameter.'."\n", 'type' => 'string', 'required' => false, 'example' => '保留字段。', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], + ], 'required' => false, - 'docRequired' => false, - 'example' => '[123, 234]', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'IsAutoStart', + 'name' => 'AvailableAssertions', 'in' => 'query', + 'style' => 'json', 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule after it is created. Default value: `false`.'."\n" - ."\n" - .'* `true`: enables the alert rule.'."\n" - .'* `false`: disables the alert rule.'."\n", - 'type' => 'boolean', + 'description' => 'The list of assertions.'."\n", + 'type' => 'array', + 'items' => [ + 'description' => '', + 'type' => 'object', + 'properties' => [ + 'Type' => ['description' => 'The assertion type. Valid values: HttpResCode, HttpResHead, HttpResBody, HttpResBodyJson, HttpResponseTime, IcmpPackLoss (packet loss rate), IcmpPackMaxLatency (maximum packet latency), IcmpPackAvgLatency (average packet latency), TraceRouteHops (number of hops), DnsARecord (A record), DnsCName (CNAME), websiteTTFB (time to first packet), websiteTTLB (time to last packet), websiteFST (first paint time), websiteFFST (first meaningful paint), websiteOnload (full loaded time). For more information, see the following description.'."\n", 'type' => 'string', 'required' => false, 'example' => 'TraceRouteHops', 'title' => ''], + 'Target' => ['description' => 'The check target. If you set the type parameter to HttpResCode, HttpResBody, or HttpResponseTime, you do not need to set the target parameter. If you set the type parameter to HttpResHead, you must specify the key in the header. If you set the type parameter to HttpResBodyJson, use jsonPath.'."\n", 'type' => 'string', 'required' => false, 'example' => 'HttpResponseTime', 'title' => ''], + 'Operator' => ['description' => 'The condition. gt: greater than. gte: greater than or equal to. lt: less than. lte: less than or equal to. eq: equal to. neq: not equal to. ctn: contain. nctn: does not contain. exist: exist. n_exist: does not exist. belong: belong to. n_belong: does not belong to. reg_match: regular expression.'."\n", 'type' => 'string', 'required' => false, 'example' => 'eq'."\n", 'title' => ''], + 'Expect' => ['description' => 'The expected value.'."\n", 'type' => 'string', 'required' => false, 'example' => '200', 'title' => ''], + ], + 'required' => false, + 'title' => '', + 'example' => '', + ], 'required' => false, - 'docRequired' => false, - 'example' => 'true', + 'title' => '', + 'example' => '', ], ], [ - 'name' => 'TemplageAlertConfig', + 'name' => 'ResourceGroupId', 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the alert template based on which you want to create an alert rule. The value must be a JSON string. You must set at least one of the **TemplateAlertId** and **TemplageAlertConfig** parameters. If you set both parameters, the **TemplateAlertId** parameter prevails. For more information about the TemplageAlertConfig parameter, see the following **additional information about the TemplageAlertConfig parameter**.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[ { "contactGroupIds": "381", "alertType": 5, "alarmContext": { "subTitle": "", "content": "Alarm name: $alarm name\\nFilter condition: $filter\\nAlarm time : $Alarm time\\nAlarm content: $Alarm content\\nNote: Before the recovery email is received, the alarm is in continuous alarm, and you will be reminded again after 24 hours!" }, "alertLevel": "WARN", " metricParam": { "appId": "70901", "pid": "atc889zkcf@d8deedfa9bf****", "type": "TXN", "dimensions": [ { "type": "STATIC", "value ": "\\\\/hello_test_api_address\\\\/test1", "key": "rpc" } ] }, "alertWay": [ "SMS", "MAIL", "DING_ROBOT" ], "alertRule": { "rules" : [ { "measure": "appstat.txn.rt", "alias": "Entry call response time_ms", "aggregates": "AVG", "nValue": 1, "value": 1, "operator ": "CURRENT_GTE" } ], "operator": "|" }, "title": "Alarm template alarm name", "config": "{\\"continuous\\":false,\\"dataRevision\\":2, \\"ownerId\\":\\"123412341234\\"}", "notice": { "noticeStartTime": 1480521600000, "startTime": 1480521600000, "endTime": 1480607940000, "noticeEndTime": 1480607940000 }, "stat us": "NON " } ]', - ], + 'schema' => ['description' => 'The resource group ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'rg-acfmxyexli2****', 'title' => ''], ], [ 'name' => 'Tags', 'in' => 'query', - 'style' => 'repeatList', + 'style' => 'json', 'schema' => [ + 'description' => 'The list of tags.'."\n", 'type' => 'array', 'items' => [ + 'description' => '', 'type' => 'object', 'properties' => [ - 'Key' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The tag key.'."\n", - 'example' => 'type', - ], - 'Value' => [ - 'type' => 'string', - 'required' => false, - 'description' => 'The tag value.'."\n", - 'example' => 'prod', - ], + 'Key' => ['description' => 'The key of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'key'."\n", 'title' => ''], + 'Value' => ['description' => 'The value of the tag.'."\n", 'type' => 'string', 'required' => false, 'example' => 'value', 'title' => ''], ], 'required' => false, + 'title' => '', + 'example' => '', ], 'required' => false, - 'maxItems' => 21, - 'description' => 'The list of tags.'."\n", + 'title' => '', + 'example' => '', ], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****'], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* `true`'."\n" + .'* `false`'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful. Other status codes indicate that the request failed.'."\n", 'type' => 'integer', 'format' => 'int64', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The message returned.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], 'Data' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'string', - 'example' => '[12174**]', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + 'description' => 'The struct returned.'."\n", + 'type' => 'object', + 'properties' => [ + 'TaskId' => ['description' => 'The task ID.'."\n", 'type' => 'string', 'example' => '1eeb351722c84e05b52c82fd0dc9953e', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"[12174**]\\",\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\"\\n}","errorExample":""},{"type":"xml","example":"<ImportAppAlertRulesResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <Data>[12174**]</Data>\\n</ImportAppAlertRulesResponse>","errorExample":""}]', - 'title' => 'ImportAppAlertRules', - 'description' => '> You can call the **ImportAppAlertRules** operation to import only the alert rules that are generated by Application Real-Time Monitoring Service (ARMS) for application monitoring and browser monitoring. This operation cannot be used to import custom alert rules, alert rules for Prometheus monitoring, or default emergency alert rules.'."\n", - 'requestParamsDescription' => '## Additional information about the **TemplageAlertConfig** parameter'."\n" - ."\n" - .'**JSON string example and description**'."\n" - ."\n" - .'```'."\n" - ."\n" - .'['."\n" - .' {'."\n" - ."\n" - .' "contactGroupIds": "381", // The ID of the alert contact group. Multiple IDs are separated by commas (,). You can ignore this parameter in the alert template configuration. The value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" - .' "alertType": 5, // The alert type. Valid values: 4 and 5. A value of 4 indicates browser monitoring. A value of 5 indicates application monitoring. '."\n" - .' "alarmContext": { // The template of the alert notification. '."\n" - .' "subTitle": "",'."\n" - .' "content": "Alert name: $alert name\\nFilter condition: $filter\\nAlert time: $alert time\\nAlert content: $alert content\\nNote: The alert remains being triggered until a reply email is received. The system will remind you 24 hours later."'."\n" - .' },'."\n" - .' "alertLevel": "WARN", // The alert severity. Valid values: FATAL, ERROR, and WARN. '."\n" - .' "metricParam": {'."\n" - .' "appId": "70901", // The ID of the associated application. You can specify an arbitrary value in the alert template configuration. The actual value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" - .' "pid": "atc889zkcf@d8deedfa9bf****", // The PID of the associated application. You can specify an arbitrary value in the alert template configuration. The actual value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" - .' "type": "TXN", // The type of the alert metric. For more information, see the following section. '."\n" - .' "dimensions": [ // The information about the associated dimension. For more information, see the following section. '."\n" - .' {'."\n" - .' "type": "STATIC",'."\n" - .' "value": "\\/hello_test_api_address\\/test1",'."\n" - .' "key": "rpc"'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "alertWay": [ // The notification method. Valid values: SMS, MAIL, and DING_ROBOT. '."\n" - .' "SMS",'."\n" - .' "MAIL",'."\n" - .' "DING_ROBOT"'."\n" - .' ],'."\n" - .' "alertRule": {'."\n" - .' "rules": [ // The conditions of the alert rule.'."\n" - .' {'."\n" - .' "measure": "appstat.txn.rt", // The metric based on which alerts are triggered. For more information, see the following section. '."\n" - .' "alias": "the response time of API calls in milliseconds", // The display parameter of the alert metric. You do not need to set this parameter for an alert template. '."\n" - .' "aggregates": "AVG", // The aggregation logic of the alert rule. Valid values: AVG, SUM, MIN, and MAX. '."\n" - .' "nValue": 1, // The time range to query. '."\n" - .' "value": 1, // The threshold of the condition. '."\n" - .' "operator": "CURRENT_GTE" // The operation logic of the condition. Valid values: CURRENT_GTE: greater than or equal to. CURRENT_LTE: less than or equal to. PREVIOUS_UP: the minute-to-minute increase percentage. PREVIOUS_DOWN: the minute-to-minute decrease percentage. HOH_UP: the increase percentage compared with the previous hour. HOH_DOWN: the decrease percentage compared with the previous hour. DOD_UP: the increase percentage compared with the last day. DOD_DOWN: the decrease percentage compared with the last day. '."\n" - .' }'."\n" - .' ],'."\n" - .' "operator": "|" // The logical operator between conditions. Valid values: &: AND. |: OR. '."\n" - .' },'."\n" - .' "title": "Template alert name", // The alert name. An alert rule name in the format of {title}-Application name is generated when ARMS creates the alert rule based on the alert template. '."\n" - .' "config": "{\\"continuous\\":false,\\"dataRevision\\":2,\\"ownerId\\":\\"123412341234\\"}", // If the continuous parameter is set to true, ARMS sends alert notifications without interruption. If the continuous parameter is set to false, an alert silence period of 24 hours is enabled. The dataRevision parameter specifies the data revision policy to be used if no data is obtained or the data is null. Valid values: 0: overwrites the data by using the value 0. 1: overwrites the data by using the value 1. 2: overwrites the data by using the value null, which means that no alert is triggered if no data exists. '."\n" - .' "notice": { // The noticeStartTime and noticeEndTime parameters specify the time range when alert notifications are sent. The startTime and endTime parameters specify the time range when the alert rule takes effect. The values are UNIX timestamps in milliseconds. Each timestamp indicates a point in time on the current day. For example, the 1565964097071 timestamp indicates 22:01:37 on August 16, 2019. '."\n" - .' "noticeStartTime": 1480521600000,'."\n" - .' "startTime": 1480521600000,'."\n" - .' "endTime": 1480607940000,'."\n" - .' "noticeEndTime": 1480607940000'."\n" - .' },'."\n" - .' "status": "NON" // The status of the alert rule. You can ignore this parameter in the alert template configuration. The value is automatically generated when ARMS creates the alert rule based on the alert template. '."\n" - .' }'."\n" - .']'."\n" - .' '."\n" - .'```'."\n" - ."\n" - .'**Description of the Measure, Dimension, and metricParam.type parameters**'."\n" - ."\n" - .'The **metricParam.type** parameter specifies the unique type of each alert rule. Each type of alert rules can use a dimension for the conditions. Multiple conditions can be set for each type of alert rules. Each condition can use multiple metrics of the same type for calculation.****'."\n" - ."\n" - .'The **Dimensions.type** parameter has the following valid values:'."\n" - ."\n" - .'* `STATIC`: checks only the value of this dimension. In this case, you must set the **dimensions.value** parameter.'."\n" - .'* `ALL`: checks the values of all dimensions. The metrics of all API operations are checked. If an operation triggers an alert, the operation name is displayed in the alert notification. In this case, you do not need to set the **dimensions.value** parameter.'."\n" - .'* `DISABLE`: aggregates the values of all dimensions. In this case, you do not need to set the **dimensions.value** parameter.'."\n" - ."\n" - .'**Alert metrics**'."\n" - ."\n" - .'* Alert type (metricParam.type): TXN'."\n" - ."\n" - .' * Dimension (dimensions.key): rpc'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.txn.rt: the response time of API calls in milliseconds'."\n" - .' * appstat.txn.count: the number of API calls'."\n" - .' * appstat.txn.errcount: the number of API call errors'."\n" + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterMissing', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'TaskQuotaLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'ParameterRegionIllegal', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'DuplicateTagKey', 'errorMessage' => 'Param tagKey is duplicate.', 'description' => ''], + ['errorCode' => 'TagNumOUT', 'errorMessage' => 'the number of tag is out .', 'description' => ''], + ['errorCode' => 'NoPermissionUSER', 'errorMessage' => 'user no permission', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'RAMNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'STSNotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'IllegalUserAccess', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'APINotAuthorize', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'CommercialStatusException', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticTrailExpired', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticInDebt', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyTimesExhausted', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'SyntheticDailyLimit', 'errorMessage' => '%s', 'description' => ''], + ['errorCode' => 'INNER_PROHIBIT', 'errorMessage' => '内部用户禁用云拨测服务, 如需使用, 请加钉钉群31359689联系白玙', 'description' => ''], + ], + ], + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": {\\n \\"TaskId\\": \\"1eeb351722c84e05b52c82fd0dc9953e\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpdateTimingSyntheticTask', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'requestParamsDescription' => 'Assertion description:'."\n" ."\n" - .'* Alert type (metricParam.type): TXN_TYPE'."\n" + .'HTTP synthetic tests:'."\n" ."\n" - .' * Dimension (dimensions.key): rpcType'."\n" + .'● If the type parameter is set to HttpResCode, the Operator parameter supports the following values: eq, neq, gt, gte, lt, lte, belong, and n_belong.'."\n" ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" + .'● If the type parameter is set to HttpResHead, the Operator parameter supports all values.'."\n" ."\n" - .' * appstat.incall.rt: the response time of API calls for the services that are provided by the application, in milliseconds'."\n" - .' * appstat.incall.count: the number of API calls for the services that are provided by the application'."\n" - .' * appstat.incall.error: the number of API call errors for the services that are provided by the application'."\n" - .' * appstat.outcall.rt: the response time of API calls for the services on which the application depends, in milliseconds'."\n" - .' * appstat.outcall.count: the number of API calls for the services on which the application depends'."\n" - .' * appstat.outcall.error: the number of API call errors for the services on which the application depends'."\n" + .'● If the type parameter is set to HttpResBody, the Operator parameter supports all values.'."\n" ."\n" - .'* Alert type (metricParam.type): DB'."\n" + .'● If the type parameter is set to HttpResBodyJson, the Operator parameter supports all values.'."\n" ."\n" - .' * Dimension (dimensions.key): endpoint'."\n" + .'● If the type parameter is set to HttpResponseTime, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" + .'ICMP synthetic tests:'."\n" ."\n" - .' * appstat.database.rt: the response time of API calls for the database'."\n" - .' * appstat.database.count: the number of API calls for the database'."\n" - .' * appstat.database.errcount: the number of API call errors for the database'."\n" + .'● If the type parameter is set to IcmpPackLoss, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .'* Alert type (metricParam.type): JVM'."\n" + .'● If the type parameter is set to IcmpPackMaxLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * Dimension (dimensions.key): rootIp'."\n" + .'● If the type parameter is set to IcmpPackAvgLatency, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" + .'● If the type parameter is set to TraceRouteHops, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * appstat.jvm.heap_used: the total memory space in the JVM heap, in bytes'."\n" - .' * appstat.jvm.GcPsScavengeCount: the number of garbage collections (GCs) in JVM'."\n" - .' * appstat.jvm.GcPsMarkSweepCount: the number of tag deletions in JVM'."\n" - .' * appstat.jvm.GcG1OldGenCount: the number of Garbage-First (G1) GCs in the old generation'."\n" - .' * appstat.jvm.GcG1YoungGenCount: the number of G1 GCs in the young generation'."\n" - .' * appstat.jvm.gc.YoungGcCountInstant: the number of GCs in the young generation'."\n" - .' * appstat.jvm.gc.OldGcCountInstant: the number of full heap GCs (Full GCs) in JVM'."\n" - .' * appstat.jvm.gc.YoungGcTimeInstant: the time that is consumed for the GCs in the young generation, in milliseconds'."\n" - .' * appstat.jvm.gc.OldGcTimeInstant: the time that is consumed for the Full GCs in JVM, in milliseconds'."\n" - .' * appstat.jvm.ThreadCount: the total number of JVM threads'."\n" - .' * appstat.jvm.non_heap_used: the used space of the non-heap JVM memory, in bytes'."\n" - .' * appstat.jvm.non_heap_max: the maximum space of the non-heap JVM memory, in bytes'."\n" - .' * appstat.jvm.non_heap_init: the initial space of the non-heap JVM memory, in bytes'."\n" - .' * appstat.jvm.non_heap_committed: the submitted space of the non-heap JVM memory, in bytes'."\n" + .'DNS synthetic tests:'."\n" ."\n" - .'* Alert type (metricParam.type): HOST'."\n" + .'● If the type parameter is set to DnsARecord, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. A records can be selectively displayed.'."\n" ."\n" - .' * Dimension (dimensions.key): rootIp'."\n" + .'● If the type parameter is set to DnsCName, the Operator parameter supports the following values: eq, ctn, nctn, reg_match, not_reg_match. CNAME records can be selectively displayed.'."\n" ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" + .'Website speed measurement:'."\n" ."\n" - .' * appstat.jvm.SystemCpuUser: the used CPU of the host, in percentage'."\n" - .' * appstat.jvm.SystemMemFree: the idle memory space of the host, in bytes'."\n" - .' * appstat.jvm.SystemDiskFree: the idle disk space of the host, in bytes'."\n" - .' * appstat.jvm.SystemNetInErrs: the number of error messages that is received by the host'."\n" - .' * appstat.jvm.SystemNetOutErrs: the number of error messages that is sent by the host'."\n" - .' * appstat.jvm.SystemLoad: the system load of the host'."\n" + .'● If the type parameter is set to websiteTTFB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .'* Alert type (metricParam.type): EXCEPTION'."\n" + .'● If the type parameter is set to websiteTTLB, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * Dimension (dimensions.key): rpc'."\n" + .'● If the type parameter is set to websiteFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" + .'● If the type parameter is set to websiteFFST, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n" ."\n" - .' * appstat.exception.rt: the response time of abnormal API calls for the application, in milliseconds'."\n" - .' * appstat.exception.count: the number of abnormal API calls for the application'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteAlertRules' => [ - 'methods' => [ - 'post', - 'get', + .'● If the type parameter is set to websiteOnload, the Operator parameter supports the following values: gt, gte, lt, lte, eq, and belong.'."\n", + 'changeSet' => [ + ['createdAt' => '2024-04-12T06:35:24.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-14T12:26:01.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-03-01T02:14:20.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-23T06:20:12.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-01-05T07:57:29.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-11-07T09:40:33.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2023-10-26T12:34:24.000Z', 'description' => 'Error codes changed, Request parameters changed'], + ['createdAt' => '2023-09-08T02:00:58.000Z', 'description' => 'Error codes changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTimingSyntheticTask'], + ], ], + 'ramActions' => [], + ], + 'UpdateWebhook' => [ + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -46317,183 +32144,55 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none'], 'parameters' => [ [ - 'name' => 'AlertIds', + 'name' => 'ContactName', 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the alert rules that you want to delete. The value is a JSON array, for example, `[123, 234]`. You can call the SearchAlertRules operation and view the `Id` parameter in the response to obtain the alert rule ID. For more information, see [SearchAlertRules](~~175825~~).'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[123, 234]', - ], + 'schema' => ['description' => 'The name of the webhook alert contact.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'Webhook告警', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'Method', 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The HTTP request method. Valid values:'."\n" + ."\n" + .'* `Get`'."\n" + .'* `Post`'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'Post', 'title' => ''], ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the alert rule was deleted.'."\n" - ."\n" - .'* `true`: The alert rule was deleted.'."\n" - .'* `false`: The alert rule failed to be deleted.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], - ], - ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => ['description' => 'The URL of the HTTP request method.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => false, 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******', 'title' => ''], ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertRulesResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n</DeleteAlertRulesResponse>","errorExample":""}]', - 'title' => 'DeleteAlertRules', - 'summary' => 'Deletes alert rules.', - 'description' => 'The current operation is no longer maintained. Call the DeleteAlertRule operation of Alert Management (New) to delete alert rules.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteAlertContact' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ [ - 'AK' => [], + 'name' => 'HttpParams', + 'in' => 'query', + 'schema' => ['description' => 'The parameters in the HTTP request.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"name":"mike"}]', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '44436', - 'abilityTreeNodes' => [ - 'FEATUREarmsK5DKZM', + [ + 'name' => 'HttpHeaders', + 'in' => 'query', + 'schema' => ['description' => 'The HTTP request headers.'."\n", 'type' => 'string', 'required' => false, 'docRequired' => false, 'example' => '[{"Content-Type":"application/json"}]', 'title' => ''], ], - ], - 'parameters' => [ [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The ID of the region.'."\n", 'type' => 'string', 'required' => true, 'docRequired' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ 'name' => 'ContactId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request. You can query logs and troubleshoot issues based on the ID.'."\n", - 'type' => 'string', - 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', - ], - ], - ], - ], - ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"78901766-3806-4E96-8E47-CFEF59E4****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertContactResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>78901766-3806-4E96-8E47-CFEF59E4****</RequestId>\\n</DeleteAlertContactResponse>","errorExample":""}]', - 'title' => 'DeleteAlertContact', - 'summary' => 'Deletes an DeleteAlertContact contact.', - 'description' => '********', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DeleteAlertContactGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], - 'security' => [ - [ - 'AK' => [], + 'schema' => ['description' => 'The ID of the webhook alert contact. You can call the **SearchAlertContact** operation to obtain the ID.'."\n", 'type' => 'integer', 'format' => 'int64', 'required' => true, 'docRequired' => true, 'maximum' => '9223372036854775807', 'minimum' => '0', 'example' => '48716', 'title' => ''], ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], - 'parameters' => [ [ - 'name' => 'RegionId', + 'name' => 'Body', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The notification template that is sent when an alert is triggered. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", 'type' => 'string', 'required' => true, 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "告警时间":"{{ .startTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }', 'title' => ''], ], [ - 'name' => 'ContactGroupId', + 'name' => 'RecoverBody', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The notification template that is sent when an alert is resolved. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", 'type' => 'string', 'required' => false, 'example' => '{ "告警名称":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "集群名称":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels._aliyun_arms_involvedObject_kind }}", "应用名称":"{{ .commonLabels._aliyun_arms_involvedObject_name }} {{ end }}", "通知策略":"{{ .dispatchRuleName }}", "恢复时间":"{{ .endTime }}", "告警内容":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }', 'title' => ''], ], ], 'responses' => [ @@ -46501,404 +32200,205 @@ 'schema' => [ 'type' => 'object', 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request, which is used to locate and troubleshoot issues.'."\n", - 'type' => 'string', - 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', - ], + 'IsSuccess' => ['description' => 'The result returned. Valid values:'."\n" + ."\n" + .'* `true`: The modification is successful.'."\n" + .'* `false`: The modification fails.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'RequestId' => ['description' => 'The ID of the request.'."\n", 'type' => 'string', 'example' => '16AF921B-8187-489F-9913-43C808B4****', 'title' => ''], ], + 'description' => '', + 'title' => '', + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"C21AB7CF-B7AF-410F-BD61-82D1567F****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteAlertContactGroupResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>C21AB7CF-B7AF-410F-BD61-82D1567F****</RequestId>\\n</DeleteAlertContactGroupResponse>","errorExample":""}]', - 'title' => 'DeleteAlertContactGroup', - 'summary' => 'Deletes an DeleteAlertContactGroup contact group.', + 'title' => 'UpdateWebhook', + 'summary' => 'Modifies the information about a webhook alert contact.', + 'description' => 'This operation is no longer maintained. Call the CreateOrUpdateWebhookContact operation in the new alter management module to create or modify a webhook alert contact.'."\n", 'requestParamsDescription' => ' ', 'responseParamsDescription' => ' ', 'extraInfo' => ' ', - ], - 'DeleteDispatchRule' => [ - 'methods' => [ - 'post', - 'get', + 'changeSet' => [ + ['createdAt' => '2021-10-28T08:06:55.000Z', 'description' => 'Request parameters changed, Error codes changed'], + ['createdAt' => '2021-10-28T08:06:55.000Z', 'description' => 'Request parameters changed'], ], - 'schemes' => [ - 'http', - 'https', + 'flowControl' => [ + 'flowControlList' => [], ], - 'security' => [ + 'ramActions' => [ [ - 'AK' => [], - ], - ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '44440', - 'abilityTreeNodes' => [ - 'FEATUREarmsVBCGEE', - ], - ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dispatch policy.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '12345', - ], - ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values: true and false.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateWebhook', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<DeleteDispatchRuleResponse>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n <Success>true</Success>\\n</DeleteDispatchRuleResponse>","errorExample":""}]', - 'title' => 'DeleteDispatchRule', - 'summary' => 'Deletes the dispatch policy of a specified ID.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateWebhookResponse>\\n <IsSuccess>true</IsSuccess>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n</UpdateWebhookResponse>","errorExample":""}]', ], - 'UpdateWebhook' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', - ], + 'UpgradeAddonRelease' => [ + 'summary' => 'Updates the release information of an add-on.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ContactName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the webhook alert contact.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'Webhook alert'."\n", - ], - ], - [ - 'name' => 'Method', + 'name' => 'AddonVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request method. Valid values:'."\n" - ."\n" - .'* `Get`'."\n" - .'* `Post`'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'Post', - ], + 'schema' => ['title' => '', 'description' => 'The version of the add-on.'."\n", 'type' => 'string', 'required' => true, 'example' => '0.0.2'], ], [ - 'name' => 'Url', + 'name' => 'Values', 'in' => 'query', - 'schema' => [ - 'description' => 'The URL of the HTTP request method.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******', - ], + 'schema' => ['title' => '', 'description' => 'The metadata information.'."\n", 'type' => 'string', 'required' => true, 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}'], ], [ - 'name' => 'HttpParams', + 'name' => 'ReleaseName', 'in' => 'query', - 'schema' => [ - 'description' => 'The parameters in the HTTP request.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"name":"mike"}]', - ], + 'schema' => ['title' => '', 'description' => 'The name of the release.'."\n", 'type' => 'string', 'required' => true, 'example' => 'mysql-1695372983039'], ], [ - 'name' => 'HttpHeaders', + 'name' => 'DryRun', 'in' => 'query', - 'schema' => [ - 'description' => 'The HTTP request headers.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[{"Content-Type":"application/json"}]', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to perform only a dry run, without performing the actual request.'."\n", 'type' => 'boolean', 'required' => false, 'example' => 'false'], ], [ 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], - ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the webhook alert contact. You can call the **SearchAlertContact** operation to obtain the ID.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775807', - 'minimum' => '0', - 'example' => '48716', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Body', - 'in' => 'query', - 'schema' => [ - 'description' => 'The notification template that is sent when an alert is triggered. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Alert time":"{{ .startTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], - ], - [ - 'name' => 'RecoverBody', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The notification template that is sent when an alert is resolved. This parameter is required if the **Method** parameter is set to **Post**. You can use the $content placeholder to specify the notification content. The content cannot exceed 500 characters in length.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '{ "Alert name":"{{ .commonLabels.alertname }}{{if .commonLabels.clustername }}", "Cluster name":"{{ .commonLabels.clustername }} {{ end }}{{if eq "app" .commonLabels.\\_aliyun_arms_involvedObject_kind }}", "Application name":"{{ .commonLabels.\\_aliyun_arms_involvedObject_name }} {{ end }}", "Notification policy":"{{ .dispatchRuleName }}", "Recovery time":"{{ .endTime }}", "Alert content":"{{ for .alerts }} {{ .annotations.message }} {{ end }}" }'."\n", - ], + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'IsSuccess' => [ - 'description' => 'The result returned. Valid values:'."\n" - ."\n" - .'* `true`: The modification is successful.'."\n" - .'* `false`: The modification fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '16AF921B-8187-489F-9913-43C808B4****', - ], + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful.'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Message' => ['description' => 'The error message returned if the request parameters are invalid.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Data' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateWebhookResponse>\\n <IsSuccess>true</IsSuccess>\\n <RequestId>16AF921B-8187-489F-9913-43C808B4****</RequestId>\\n</UpdateWebhookResponse>","errorExample":""}]', - 'title' => 'UpdateWebhook', - 'summary' => 'Modifies the information about a webhook alert contact.', - 'description' => 'This operation is no longer maintained. Call the CreateOrUpdateWebhookContact operation in the new alter management module to create or modify a webhook alert contact.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateAlertContact' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => 'UpgradeAddonRelease', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeAddonRelease'], + ], ], + 'ramActions' => [], + ], + 'UpgradeEnvironmentFeature' => [ + 'summary' => 'Updates the feature information of an environment.', + 'methods' => ['post', 'get'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], ], ], - 'operationType' => 'readAndWrite', + 'operationType' => 'read', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'none', 'riskType' => 'none', 'chargeType' => 'free'], 'parameters' => [ [ - 'name' => 'ContactName', + 'name' => 'EnvironmentId', 'in' => 'query', - 'schema' => [ - 'description' => 'The new name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'John Doe', - ], + 'schema' => ['title' => '', 'description' => 'The environment ID.'."\n", 'type' => 'string', 'required' => true, 'example' => 'env-xxx'], ], [ - 'name' => 'PhoneNum', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The new mobile phone number of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" - ."\n" - .'> If you do not specify this parameter, the original parameter value is deleted. If you specify this parameter, the original parameter value is updated.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1381111****', - ], + 'schema' => ['description' => 'The region ID.'."\n", 'type' => 'string', 'required' => false, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'Email', + 'name' => 'FeatureName', 'in' => 'query', - 'schema' => [ - 'description' => 'The new email address of the alert contact. You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" - ."\n" - .'> If you do not specify this parameter, the original parameter value is deleted. If you specify this parameter, the original parameter value is updated.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'someone@example.com', - ], + 'schema' => ['title' => '', 'description' => 'The feature name. Valid values: app-agent-pilot, metric-agent, ebpf-agent, and service-check.'."\n", 'type' => 'string', 'required' => true, 'example' => 'metric-agent'], ], [ - 'name' => 'DingRobotWebhookUrl', - 'in' => 'query', - 'schema' => [ - 'description' => 'The new webhook URL of the DingTalk chatbot. For more information, see [Configure a DingTalk chatbot to send alert notifications](~~106247~~). You must specify at least one of the following parameters: PhoneNum, Email, and DingRobotWebhookUrl.'."\n" - ."\n" - .'> If you do not specify this parameter, the original parameter value is deleted. If you specify this parameter, the original parameter value is updated.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', - ], - ], - [ - 'name' => 'SystemNoc', + 'name' => 'FeatureVersion', 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the alert contact receives system notifications. Valid values:'."\n" - ."\n" - .'* `true`: The alert contact receives system notifications.'."\n" - .'* `false`: The alert contact does not receive system notifications.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', - ], + 'schema' => ['title' => '', 'description' => 'The version of the feature.'."\n", 'type' => 'string', 'required' => false, 'example' => '1.1.17'], ], [ - 'name' => 'RegionId', + 'name' => 'Values', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['title' => '', 'description' => 'Specifies whether to enable service discovery. For PodAnnotation, set the value to run or mini. For PodMonitor and ServiceMonitor, set the value to true or false.'."\n", 'type' => 'string', 'required' => false, 'example' => '{"PodAnnotation":"run"}'], ], [ - 'name' => 'ContactId', + 'name' => 'AliyunLang', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact to be updated. You can call the SearchAlertContact operation to query the contact ID. For more information, see [SearchAlertContact](~~130703~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['title' => '', 'description' => 'The language. Valid values: zh and en. Default value: zh.'."\n", 'type' => 'string', 'required' => false, 'example' => 'zh'], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the alert contact was updated. Valid values:'."\n" - ."\n" - .'* true: The alert contact was updated.'."\n" - .'* false: The alert contact failed to be updated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6'], + 'Code' => ['description' => 'The status code. The status code 200 indicates that the request was successful.'."\n", 'type' => 'integer', 'format' => 'int32', 'example' => '200', 'title' => ''], + 'Message' => ['description' => 'The returned message.'."\n", 'type' => 'string', 'example' => 'success', 'title' => ''], + 'Success' => ['description' => 'Indicates whether the request was successful. Valid values:'."\n" + ."\n" + .'* true'."\n" + .'* false'."\n", 'type' => 'boolean', 'example' => 'true', 'title' => ''], + 'Data' => [ + 'description' => 'The status of the job.'."\n", + 'type' => 'object', + 'additionalProperties' => ['type' => 'string', 'example' => '{'."\n" + .' "PodAnnotation": "run"'."\n" + .' }', 'description' => 'The status value.'."\n", 'title' => ''], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlertContactResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>1A474FF8-7861-4D00-81B5-5BC3DA4E****</RequestId>\\n</UpdateAlertContactResponse>","errorExample":""}]', - 'title' => 'UpdateAlertContact', - 'summary' => 'Updates an alert contact.', - 'description' => 'This operation is no longer maintained. To create or modify an alert contact, call the CreateOrUpdateContact operation provided by the new version of Alert Management.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateAlertContactGroup' => [ - 'methods' => [ - 'post', - 'get', - ], - 'schemes' => [ - 'http', - 'https', + 'staticInfo' => ['returnType' => 'synchronous'], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"01FF8DD9-A09C-47A1-895A-B6E321BE77B6\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"key\\": \\"{\\\\n \\\\\\"PodAnnotation\\\\\\": \\\\\\"run\\\\\\"\\\\n }\\"\\n }\\n}","type":"json"}]', + 'title' => 'UpgradeEnvironmentFeature', + 'changeSet' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeEnvironmentFeature'], + ], ], + 'ramActions' => [], + ], + 'Upload' => [ + 'summary' => 'Uploads a SourceMap file to ARMS Browser Monitoring.', + 'methods' => ['post'], + 'schemes' => ['http', 'https'], 'security' => [ [ 'AK' => [], @@ -46906,4099 +32406,6103 @@ ], 'operationType' => 'readAndWrite', 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - ], + 'systemTags' => ['operationType' => 'update'], 'parameters' => [ [ - 'name' => 'ContactGroupName', + 'name' => 'RegionId', 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'TestGroup', - ], + 'schema' => ['description' => 'The ID of the region to which the SourceMap file is uploaded.'."\n", 'type' => 'string', 'required' => true, 'example' => 'cn-hangzhou', 'title' => ''], ], [ - 'name' => 'ContactIds', + 'name' => 'Pid', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '123 234 345', - ], + 'schema' => ['description' => 'The application ID.'."\n" + ."\n" + .'Log on to the **ARMS console**. In the left-side navigation pane, choose **Browser Monitoring** > **Browser Monitoring**. On the Browser Monitoring page, click the name of an application. The URL in the address bar contains the process ID (PID) of the application. The PID is indicated in the pid=xxx format. The PID is usually percent encoded as xxx%40xxx. You must modify this value to remove the percent encoding. For example, if the PID in the URL is eb4zdose6v%409781be0f44d\\*\\*\\*\\*, you must replace %40 with @ to obtain eb4zdose6v@9781be0f44d\\*\\*\\*\\*.'."\n", 'type' => 'string', 'required' => true, 'example' => 'b590lhguqs@8cc3f6354******', 'title' => ''], ], [ - 'name' => 'RegionId', + 'name' => 'FileName', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', - ], + 'schema' => ['description' => 'The name of the SourceMap file.'."\n", 'type' => 'string', 'required' => true, 'example' => 'test.js.map', 'title' => ''], ], [ - 'name' => 'ContactGroupId', + 'name' => 'File', + 'in' => 'formData', + 'schema' => ['description' => 'The string of the SourceMap file.'."\n", 'type' => 'string', 'required' => false, 'example' => 'test file content', 'title' => ''], + ], + [ + 'name' => 'Edition', 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '123', - ], + 'schema' => ['description' => 'The version of the SourceMap file.'."\n", 'type' => 'string', 'required' => false, 'example' => '0.0.0', 'title' => ''], ], ], 'responses' => [ 200 => [ 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response'."\n", 'type' => 'object', 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', + 'RequestId' => ['title' => 'Id of the request', 'description' => 'The request ID.'."\n", 'type' => 'string', 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****'], + 'UploadResult' => [ + 'description' => 'The returned data.'."\n", + 'type' => 'object', + 'properties' => [ + 'Fid' => ['description' => 'The ID of the SourceMap file.'."\n", 'type' => 'string', 'example' => '123', 'title' => ''], + 'FileName' => ['description' => 'The name of the SourceMap file.'."\n", 'type' => 'string', 'example' => 'test.js.map', 'title' => ''], + 'UploadTime' => ['description' => 'The time when the file was uploaded.'."\n", 'type' => 'string', 'example' => '1650272251', 'title' => ''], + ], + 'title' => '', + 'example' => '', ], ], + 'example' => '', ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"9319A57D-2D9E-472A-B69B-CF3CD16D****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateAlertContactGroupResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>9319A57D-2D9E-472A-B69B-CF3CD16D****</RequestId>\\n</UpdateAlertContactGroupResponse>","errorExample":""}]', - 'title' => 'UpdateAlertContactGroup', - 'summary' => 'Updates UpdateAlertContactGroup alarm contact group.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateAlertRule' => [ - 'methods' => [ - 'post', - 'get', + 'errorCodes' => [ + 400 => [ + ['errorCode' => 'ParameterRegionIdMissing', 'errorMessage' => 'You must specify regionId.', 'description' => 'You must specify regionId.'], + ['errorCode' => 'InternalError', 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'description' => ''], + ], + 403 => [ + ['errorCode' => 'APINotAuthorize', 'errorMessage' => 'The current user is not authorized to access the interface.', 'description' => 'The current user is not authorized to access the interface.'], + ], ], - 'schemes' => [ - 'http', - 'https', + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"UploadResult\\": {\\n \\"Fid\\": \\"123\\",\\n \\"FileName\\": \\"test.js.map\\",\\n \\"UploadTime\\": \\"1650272251\\"\\n }\\n}","errorExample":""},{"type":"xml","example":"<UploadResponse>\\n <RequestId>xxxx</RequestId>\\n <Fid>1.0</Fid>\\n <FileName>test.txt</FileName>\\n <Version>0.0.0</Version>\\n <UploadTime>xxx</UploadTime>\\n</UploadResponse>","errorExample":""}]', + 'title' => 'Upload', + 'changeSet' => [ + ['createdAt' => '2024-07-11T05:43:04.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-06-19T01:54:56.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2024-02-01T11:52:01.000Z', 'description' => 'Response parameters changed'], + ['createdAt' => '2023-09-04T09:44:05.000Z', 'description' => 'Error codes changed'], + ['createdAt' => '2022-06-29T12:16:10.000Z', 'description' => 'Request parameters changed, Response parameters changed'], + ['createdAt' => '2022-06-07T12:16:59.000Z', 'description' => 'Request parameters changed'], + ['createdAt' => '2022-03-24T13:00:11.000Z', 'description' => 'Request parameters changed'], ], - 'security' => [ - [ - 'AK' => [], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Upload'], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + 'ramActions' => [], + ], + ], + 'endpoints' => [ + ['regionId' => 'cn-wulanchabu', 'regionName' => 'China (Ulanqab)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-wulanchabu.aliyuncs.com', 'endpoint' => 'arms.cn-wulanchabu.aliyuncs.com', 'vpc' => 'arms-vpc.cn-wulanchabu.aliyuncs.com'], + ['regionId' => 'cn-beijing', 'regionName' => 'China (Beijing)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-beijing.aliyuncs.com', 'endpoint' => 'arms.cn-beijing.aliyuncs.com', 'vpc' => 'arms-vpc.cn-beijing.aliyuncs.com'], + ['regionId' => 'cn-zhengzhou-jva', 'regionName' => 'Zhengzhou (China Unicom Joint Venture)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-zhengzhou-jva.aliyuncs.com', 'endpoint' => 'arms.cn-zhengzhou-jva.aliyuncs.com', 'vpc' => 'arms-vpc.cn-zhengzhou-jva.aliyuncs.com'], + ['regionId' => 'cn-qingdao', 'regionName' => 'China (Qingdao)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-qingdao.aliyuncs.com', 'endpoint' => 'arms.cn-qingdao.aliyuncs.com', 'vpc' => 'arms-vpc.cn-qingdao.aliyuncs.com'], + ['regionId' => 'cn-shanghai', 'regionName' => 'China (Shanghai)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-shanghai.aliyuncs.com', 'endpoint' => 'arms.cn-shanghai.aliyuncs.com', 'vpc' => 'arms-vpc.cn-shanghai.aliyuncs.com'], + ['regionId' => 'cn-hongkong', 'regionName' => 'China (Hong Kong)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-hongkong.aliyuncs.com', 'endpoint' => 'arms.cn-hongkong.aliyuncs.com', 'vpc' => 'arms-vpc.cn-hongkong.aliyuncs.com'], + ['regionId' => 'cn-heyuan', 'regionName' => 'China (Heyuan)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-heyuan.aliyuncs.com', 'endpoint' => 'arms.cn-heyuan.aliyuncs.com', 'vpc' => 'arms-vpc.cn-heyuan.aliyuncs.com'], + ['regionId' => 'cn-zhangjiakou', 'regionName' => 'China (Zhangjiakou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-zhangjiakou.aliyuncs.com', 'endpoint' => 'arms.cn-zhangjiakou.aliyuncs.com', 'vpc' => 'arms-vpc.cn-zhangjiakou.aliyuncs.com'], + ['regionId' => 'cn-shenzhen', 'regionName' => 'China (Shenzhen)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-shenzhen.aliyuncs.com', 'endpoint' => 'arms.cn-shenzhen.aliyuncs.com', 'vpc' => 'arms-vpc.cn-shenzhen.aliyuncs.com'], + ['regionId' => 'ap-northeast-2', 'regionName' => 'South Korea (Seoul)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-northeast-2.aliyuncs.com', 'endpoint' => 'arms.ap-northeast-2.aliyuncs.com', 'vpc' => 'arms-vpc.ap-northeast-2.aliyuncs.com'], + ['regionId' => 'ap-northeast-1', 'regionName' => 'Japan (Tokyo)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-northeast-1.aliyuncs.com', 'endpoint' => 'arms.ap-northeast-1.aliyuncs.com', 'vpc' => 'arms-vpc.ap-northeast-1.aliyuncs.com'], + ['regionId' => 'cn-chengdu', 'regionName' => 'China (Chengdu)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-chengdu.aliyuncs.com', 'endpoint' => 'arms.cn-chengdu.aliyuncs.com', 'vpc' => 'arms-vpc.cn-chengdu.aliyuncs.com'], + ['regionId' => 'cn-guangzhou', 'regionName' => 'China (Guangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-guangzhou.aliyuncs.com', 'endpoint' => 'arms.cn-guangzhou.aliyuncs.com', 'vpc' => 'arms-vpc.cn-guangzhou.aliyuncs.com'], + ['regionId' => 'ap-southeast-1', 'regionName' => 'Singapore', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-southeast-1.aliyuncs.com', 'endpoint' => 'arms.ap-southeast-1.aliyuncs.com', 'vpc' => 'arms-vpc.ap-southeast-1.aliyuncs.com'], + ['regionId' => 'ap-southeast-2', 'regionName' => 'Australia (Sydney) Closed', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-southeast-2.aliyuncs.com', 'endpoint' => 'arms.ap-southeast-2.aliyuncs.com', 'vpc' => 'arms-vpc.ap-southeast-2.aliyuncs.com'], + ['regionId' => 'ap-southeast-3', 'regionName' => 'Malaysia (Kuala Lumpur)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-southeast-3.aliyuncs.com', 'endpoint' => 'arms.ap-southeast-3.aliyuncs.com', 'vpc' => 'arms-vpc.ap-southeast-3.aliyuncs.com'], + ['regionId' => 'cn-huhehaote', 'regionName' => 'China (Hohhot)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-huhehaote.aliyuncs.com', 'endpoint' => 'arms.cn-huhehaote.aliyuncs.com', 'vpc' => 'arms-vpc.cn-huhehaote.aliyuncs.com'], + ['regionId' => 'ap-southeast-5', 'regionName' => 'Indonesia (Jakarta)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-southeast-5.aliyuncs.com', 'endpoint' => 'arms.ap-southeast-5.aliyuncs.com', 'vpc' => 'arms-vpc.ap-southeast-5.aliyuncs.com'], + ['regionId' => 'ap-southeast-6', 'regionName' => 'Philippines (Manila)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-southeast-6.aliyuncs.com', 'endpoint' => 'arms.ap-southeast-6.aliyuncs.com', 'vpc' => 'arms-vpc.ap-southeast-6.aliyuncs.com'], + ['regionId' => 'ap-southeast-7', 'regionName' => 'Thailand (Bangkok)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.ap-southeast-7.aliyuncs.com', 'endpoint' => 'arms.ap-southeast-7.aliyuncs.com', 'vpc' => 'arms-vpc.ap-southeast-7.aliyuncs.com'], + ['regionId' => 'cn-hangzhou', 'regionName' => 'China (Hangzhou)', 'areaId' => 'asiaPacific', 'areaName' => 'Asia Pacific', 'public' => 'arms.cn-hangzhou.aliyuncs.com', 'endpoint' => 'arms.cn-hangzhou.aliyuncs.com', 'vpc' => 'arms-vpc.cn-hangzhou.aliyuncs.com'], + ['regionId' => 'us-east-1', 'regionName' => 'US (Virginia)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'arms.us-east-1.aliyuncs.com', 'endpoint' => 'arms.us-east-1.aliyuncs.com', 'vpc' => 'arms-vpc.us-east-1.aliyuncs.com'], + ['regionId' => 'eu-west-1', 'regionName' => 'UK (London)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'arms.eu-west-1.aliyuncs.com', 'endpoint' => 'arms.eu-west-1.aliyuncs.com', 'vpc' => 'arms-vpc.eu-west-1.aliyuncs.com'], + ['regionId' => 'eu-central-1', 'regionName' => 'Germany (Frankfurt)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'arms.eu-central-1.aliyuncs.com', 'endpoint' => 'arms.eu-central-1.aliyuncs.com', 'vpc' => 'arms-vpc.eu-central-1.aliyuncs.com'], + ['regionId' => 'us-west-1', 'regionName' => 'US (Silicon Valley)', 'areaId' => 'europeAmerica', 'areaName' => 'Europe & Americas', 'public' => 'arms.us-west-1.aliyuncs.com', 'endpoint' => 'arms.us-west-1.aliyuncs.com', 'vpc' => ''], + ['regionId' => 'me-east-1', 'regionName' => 'UAE (Dubai)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'arms.aliyuncs.com', 'endpoint' => 'arms.aliyuncs.com', 'vpc' => 'arms-vpc.me-east-1.aliyuncs.com'], + ['regionId' => 'me-central-1', 'regionName' => 'Saudi Arabia (Riyadh)', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'arms.me-central-1.aliyuncs.com', 'endpoint' => 'arms.me-central-1.aliyuncs.com', 'vpc' => 'arms-vpc.me-central-1.aliyuncs.com'], + ['regionId' => 'ap-south-1', 'regionName' => 'India (Mumbai) Closed', 'areaId' => 'middleEast', 'areaName' => 'Middle East', 'public' => 'arms.ap-south-1.aliyuncs.com', 'endpoint' => 'arms.ap-south-1.aliyuncs.com', 'vpc' => 'arms-vpc.ap-south-1.aliyuncs.com'], + ['regionId' => 'cn-hangzhou-finance', 'regionName' => 'China East 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'arms.cn-hangzhou-finance.aliyuncs.com', 'endpoint' => 'arms.cn-hangzhou-finance.aliyuncs.com', 'vpc' => 'arms-vpc.cn-hangzhou-finance.aliyuncs.com'], + ['regionId' => 'cn-heyuan-acdr-1', 'regionName' => 'Heyuan ACDR Auto', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'arms.cn-heyuan-acdr-1.aliyuncs.com', 'endpoint' => 'arms.cn-heyuan-acdr-1.aliyuncs.com', 'vpc' => 'arms-vpc.cn-heyuan-acdr-1.aliyuncs.com'], + ['regionId' => 'cn-shenzhen-finance-1', 'regionName' => 'China South 1 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'arms.cn-shenzhen-finance-1.aliyuncs.com', 'endpoint' => 'arms.cn-shenzhen-finance-1.aliyuncs.com', 'vpc' => 'arms-vpc.cn-shenzhen-finance-1.aliyuncs.com'], + ['regionId' => 'cn-beijing-finance-1', 'regionName' => 'China North 2 Finance (Preview)', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'arms.aliyuncs.com', 'endpoint' => 'arms.aliyuncs.com', 'vpc' => 'arms-vpc.cn-beijing-finance-1.aliyuncs.com'], + ['regionId' => 'cn-shanghai-finance-1', 'regionName' => 'China East 2 Finance', 'areaId' => 'industryCloud', 'areaName' => 'Industry Cloud', 'public' => 'arms.cn-shanghai-finance-1.aliyuncs.com', 'endpoint' => 'arms.cn-shanghai-finance-1.aliyuncs.com', 'vpc' => 'arms-vpc.cn-shanghai-finance-1.aliyuncs.com'], + ], + 'errorCodes' => [ + ['code' => 'AccountUidAccessError', 'message' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'http_code' => 500, 'description' => 'Failed to obtain the user information. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['code' => 'AgentNotUninstalled', 'message' => 'agent not uninstalled.', 'http_code' => 406, 'description' => 'The agent attached by the application is not uninstalled normally.'], + ['code' => 'AlertIdsIllegal', 'message' => 'Parameter alertIds must be a JsonArray consisting of Long values.', 'http_code' => 400, 'description' => 'Parameter alertIds must be a JsonArray consisting of Long values.'], + ['code' => 'AlertPhoneNumberIllegal', 'message' => 'Alarm phone number is illegal.', 'http_code' => 400, 'description' => 'Alarm phone number is illegal'], + ['code' => 'AlertPhoneVerifyTooFrequently', 'message' => 'Verification links are sent too frequently.', 'http_code' => 400, 'description' => 'Verification links are sent too frequently'], + ['code' => 'AlertRuleNotExist', 'message' => 'The alert rule does not exist.', 'http_code' => 404, 'description' => 'The alert rule does not exist.'], + ['code' => 'AlertRuleTypeIllegal', 'message' => 'The alert rule type is invalid.', 'http_code' => 400, 'description' => 'The alert rule type is invalid.'], + ['code' => 'APINotAuthorize', 'message' => 'The current user is not authorized to access the interface.', 'http_code' => 403, 'description' => 'The current user is not authorized to access the interface.'], + ['code' => 'AppNotExist', 'message' => 'The application does not exist.', 'http_code' => 404, 'description' => 'The application does not exist.'], + ['code' => 'ARMSNotOpen', 'message' => 'ARMS is not activated.', 'http_code' => 403, 'description' => 'ARMS is not activated.'], + ['code' => 'ARMSUserNotRegistry', 'message' => 'User information is being registered. Please try again later.', 'http_code' => 403, 'description' => 'User information is being registered. Please try again later.'], + ['code' => 'CommercialNotOpend', 'message' => 'ARMS commercial status is not open.', 'http_code' => 403, 'description' => 'ARMS Commercial status is not open'], + ['code' => 'CommercialStatusException', 'message' => 'Abnormal commercialization status. Please contact your administrator.', 'http_code' => 403, 'description' => 'Abnormal commercialization status. Please contact your administrator.'], + ['code' => 'CommercialUsageLimitNotAllowed', 'message' => 'Commercial usage limitation is not allowed.', 'http_code' => 403, 'description' => 'Commercial usage limitation is allowed after reporting data success'], + ['code' => 'ConcurrentModification', 'message' => 'Another client has modified the current configuration, please refresh and try again.', 'http_code' => 409, 'description' => 'Another client has modified the current configuration, please refresh and try again.'], + ['code' => 'ContactGroupLimit', 'message' => 'The maximum number of contact groups is exceeded. Please contact the DingTalk service account.', 'http_code' => 403, 'description' => 'The maximum number of contact groups is exceeded. Please contact the DingTalk service account.'], + ['code' => 'ContactNotExist', 'message' => 'The alert contact does not exist.', 'http_code' => 404, 'description' => 'The alert contact does not exist.'], + ['code' => 'CustomTrialExpired', 'message' => 'The trial period of Custom Monitoring has expired. Please go to the console to activate Pay-As-You-Go for Custom Monitoring.', 'http_code' => 403, 'description' => 'The trial period of Custom Monitoring has expired. Please go to the console to activate Pay-As-You-Go for Custom Monitoring.'], + ['code' => 'DatasetNotExist', 'message' => 'The data set does not exist.', 'http_code' => 404, 'description' => 'The data set does not exist.'], + ['code' => 'DuplicateTagKey', 'message' => 'The tag key must be unique.', 'http_code' => 400, 'description' => 'The tag key must be unique.'], + ['code' => 'EventSetNotExist', 'message' => 'The event set does not exist.', 'http_code' => 404, 'description' => 'The event set does not exist.'], + ['code' => 'IllegalUserAccess', 'message' => 'Illegal user access.', 'http_code' => 403, 'description' => 'Illegal user access.'], + ['code' => 'InnerUserBuyIllegal', 'message' => 'Group user on the cloud cannot purchase non-internal commodities.', 'http_code' => 400, 'description' => 'Group users on the cloud cannot purchase non-internal commodities.'], + ['code' => 'InternalError', 'message' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', 'http_code' => 500, 'description' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.'], + ['code' => 'InvalidParameterTagKey', 'message' => 'param tagKey is invalid.', 'http_code' => 400, 'description' => 'The specified tagKey parameter is invalid.'], + ['code' => 'InvalidParameterTagKey', 'message' => 'The specified TagKey is invalid.', 'http_code' => 400, 'description' => 'The specified TagKey parameter is invalid.'], + ['code' => 'InvalidParameterTagValue', 'message' => 'The specified TagValue is invalid.', 'http_code' => 400, 'description' => 'The specified TagValue parameter is invalid.'], + ['code' => 'NoPermissionKeyOperator', 'message' => 'The user does not have the permissions to manage the tag key.', 'http_code' => 400, 'description' => 'The user does not have the permissions to manage the tag key.'], + ['code' => 'NoPermissionUSER', 'message' => 'No permissions.', 'http_code' => 400, 'description' => 'The user does not have the permissions to perform the operation.'], + ['code' => 'NotRDEntity.Account', 'message' => 'The account does not belong to a resource directory organization.', 'http_code' => 200, 'description' => 'The account does not belong to the resource directory.'], + ['code' => 'OperationIsThrottled', 'message' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.', 'http_code' => 429, 'description' => 'The backend service cannot fully process the current request. The returned result may be incomplete. Adjust the operation conditions and try again.'], + ['code' => 'OperationTimeOut', 'message' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.', 'http_code' => 452, 'description' => 'The system timed out when processing the current request. The request may involve too many resources and the system cannot complete the processing within the limited time. Please adjust the relevant conditions and try again.'], + ['code' => 'OrderOpen', 'message' => 'The service is already activated.', 'http_code' => 400, 'description' => 'The service is already activated.'], + ['code' => 'ParameterAlertIdIllegal', 'message' => 'The specified alertIds is invalid.', 'http_code' => 400, 'description' => 'The specified alertIds is invalid.'], + ['code' => 'ParameterAlertTypeIllegal', 'message' => 'The specified alertType is invalid.', 'http_code' => 400, 'description' => 'The specified alertType is invalid.'], + ['code' => 'ParameterAppIDMissing', 'message' => 'You must specify appId.', 'http_code' => 400, 'description' => 'You must specify appId.'], + ['code' => 'ParameterConfigIllegal', 'message' => 'The specified Config is invalid.', 'http_code' => 400, 'description' => 'The specified config parameter is invalid.'], + ['code' => 'ParameterContactGroupIllegal', 'message' => 'Contact Group must be a JsonArray.', 'http_code' => 400, 'description' => 'Contact Group must be a JsonArray.'], + ['code' => 'ParameterDimensionsIllegal', 'message' => 'The specified dimensions is invalid.', 'http_code' => 400, 'description' => 'The specified dimensions is invalid.'], + ['code' => 'ParameterFilterKeyIllegal', 'message' => 'The specified FilterKey is invalid.', 'http_code' => 400, 'description' => 'The specified filterKey parameter is invalid.'], + ['code' => 'ParameterFilterOperatorIllegal', 'message' => 'The specified FilterOpt is invalid.', 'http_code' => 400, 'description' => 'The specified filterOpt parameter is invalid.'], + ['code' => 'ParameterFilterTypeIllegal', 'message' => 'The specified FilterType is invalid.', 'http_code' => 400, 'description' => 'The specified filterType parameter is invalid.'], + ['code' => 'ParameterGroupTypeIllegal', 'message' => 'The specified GroupType is invalid.', 'http_code' => 400, 'description' => 'The specified groupType parameter is invalid.'], + ['code' => 'ParameterIllegal', 'message' => 'The specified parameter is invalid.', 'http_code' => 400, 'description' => 'The specified parameter is invalid.'], + ['code' => 'ParameterInterceptorTypeIllegal', 'message' => 'The specified InterceptorType is invalid.', 'http_code' => 400, 'description' => 'The specified interceptorType parameter is invalid.'], + ['code' => 'ParameterIntervalIllegal', 'message' => 'The specified interval is invalid.', 'http_code' => 400, 'description' => 'The specified interval is invalid.'], + ['code' => 'ParameterIsTriggerIllegal', 'message' => 'The specified isTrigger is invalid.', 'http_code' => 400, 'description' => 'The specified isTrigger is invalid.'], + ['code' => 'ParameterLimitIllegal', 'message' => 'The specified limit is invalid.', 'http_code' => 400, 'description' => 'The specified limit is invalid.'], + ['code' => 'ParameterMeasuresIllegal', 'message' => 'The specified Measures is invalid.', 'http_code' => 400, 'description' => 'The specified Measures is invalid.'], + ['code' => 'ParameterMeasuresMissing', 'message' => 'You must specify measures.', 'http_code' => 400, 'description' => 'You must specify measures.'], + ['code' => 'ParameterMetricIllegal', 'message' => 'The specified metric is invalid.', 'http_code' => 400, 'description' => 'The specified metric is invalid.'], + ['code' => 'ParameterMissing', 'message' => 'You must specify the parameter.', 'http_code' => 400, 'description' => 'You must specify the parameter.'], + ['code' => 'ParameterNameMatchTypeIllegal', 'message' => 'The specified NameMatchType is invalid.', 'http_code' => 400, 'description' => 'The specified nameMatchType parameter is invalid.'], + ['code' => 'ParameterNextTokenIllegal', 'message' => 'The specified nextToken parameter is invalid.', 'http_code' => 400, 'description' => 'The specified nextToken parameter is invalid.'], + ['code' => 'ParameterOperatorIllegal', 'message' => 'The specified Operator is invalid.', 'http_code' => 400, 'description' => 'The specified operator parameter is invalid.'], + ['code' => 'ParameterOrderIllegal', 'message' => 'The specified order is invalid.', 'http_code' => 400, 'description' => 'The specified order is invalid.'], + ['code' => 'ParameterPageSizeIllegal', 'message' => 'The specified PageSize is invalid.', 'http_code' => 400, 'description' => 'The specified PageSize is invalid.'], + ['code' => 'ParameterPidMissing', 'message' => 'You must specify pid.', 'http_code' => 400, 'description' => 'You must specify pid.'], + ['code' => 'ParameterPidsMissing', 'message' => 'You must specify pids.', 'http_code' => 400, 'description' => 'You must specify pids.'], + ['code' => 'ParameterRegionIdIllegal', 'message' => 'The specified RegionId is invalid.', 'http_code' => 400, 'description' => 'The specified RegionId is invalid.'], + ['code' => 'ParameterRegionIdMissing', 'message' => 'You must specify regionId.', 'http_code' => 400, 'description' => 'You must specify regionId.'], + ['code' => 'ParameterRegionIllegal', 'message' => 'The specified region is invalid.', 'http_code' => 400, 'description' => 'The specified region is invalid.'], + ['code' => 'ParameterRpcTypeIllegal', 'message' => 'The specified RpcType is invalid.', 'http_code' => 400, 'description' => 'The specified rpcType parameter is invalid.'], + ['code' => 'ParameterScenarioIllegal', 'message' => 'The specified Scenario is invalid.', 'http_code' => 400, 'description' => 'The specified scenario parameter is invalid.'], + ['code' => 'ParameterServiceIllegal', 'message' => 'The specified Service is invalid.', 'http_code' => 400, 'description' => 'The specified service parameter is invalid.'], + ['code' => 'ParameterSiteTypeIllegal', 'message' => 'The specified site type of Browser Monitoring is invalid.', 'http_code' => 400, 'description' => 'The specified site type of Browser Monitoring is invalid.'], + ['code' => 'ParameterTagValueInvalid', 'message' => 'param tagValue is invalid', 'http_code' => 400, 'description' => 'The specified tagValue parameter is invalid.'], + ['code' => 'ParameterTemplateAlertConfigIllegal', 'message' => 'The specified templateAlertConfig is invalid.', 'http_code' => 400, 'description' => 'The specified templateAlertConfig is invalid.'], + ['code' => 'ParameterTemplateAlertIdIllegal', 'message' => 'The specified templateAlertId is invalid.', 'http_code' => 400, 'description' => 'The specified templateAlertId is invalid.'], + ['code' => 'ParameterTimeStampIllegal', 'message' => 'The specified timeStamp is invalid.', 'http_code' => 400, 'description' => 'The specified timeStamp is invalid.'], + ['code' => 'ParameterTimeStampMissing', 'message' => 'You must specify timeStamp.', 'http_code' => 400, 'description' => 'You must specify timeStamp.'], + ['code' => 'ParameterTopologyTypeIllegal', 'message' => 'The specified topologyType is invalid.', 'http_code' => 400, 'description' => 'The specified topologyType is invalid.'], + ['code' => 'ParameterTraceAppSettingKeyIllegal', 'message' => 'The application configuration key is invalid.', 'http_code' => 400, 'description' => 'The application configuration key is invalid.'], + ['code' => 'ParameterTraceAppSettingValueIllegal', 'message' => 'The application configuration value is invalid.', 'http_code' => 400, 'description' => 'The application configuration value is invalid.'], + ['code' => 'ParameterTraceIdIllegal', 'message' => 'The specified traceId is invalid.', 'http_code' => 400, 'description' => 'The specified traceId is invalid.'], + ['code' => 'ParameterTraceIdMissing', 'message' => 'You must specify traceId.', 'http_code' => 400, 'description' => 'You must specify traceId.'], + ['code' => 'ParameterTraceIdsIllegal', 'message' => 'The length of traceId list cannot exceed 10.', 'http_code' => 400, 'description' => 'The length of traceId list cannot exceed 10.'], + ['code' => 'ParameterUserIdMissing', 'message' => 'You must specify userId.', 'http_code' => 400, 'description' => 'You must specify userId.'], + ['code' => 'ParameterZeroStrategyIllegal', 'message' => 'The specified zeroStrategy is invalid.', 'http_code' => 400, 'description' => 'The specified zeroStrategy is invalid.'], + ['code' => 'PermissionDenied.ServicePrincipal', 'message' => 'The account does not have trusted service permissions.', 'http_code' => 200, 'description' => 'The account does not have the permissions of the trusted service.'], + ['code' => 'QueryTraceLogStoreError', 'message' => 'Query trace storage error.', 'http_code' => 500, 'description' => 'An error occurred while querying the trace storage'], + ['code' => 'RAMNotAuthorize', 'message' => 'The sub-account is not authorized and must be granted AliyunARMSFullAccess by a primary account.', 'http_code' => 403, 'description' => 'The RAM user does not have access permissions. You must use the Alibaba Cloud account to grant the AliyunARMSFullAccess permission to the RAM user.'], + ['code' => 'RAMNotAuthorize', 'message' => 'SubUser permission verification failed, the caller is not authorized to perform %s on resource %s.', 'http_code' => 403, 'description' => 'Authentication failed because the RAM user is not authorized to perform the %s operation on the %s resource.'], + ['code' => 'ResourceIdAndTagIsNull', 'message' => 'Specify at least one of the resourceId and tag parameters.', 'http_code' => 400, 'description' => 'Specify at least one of the resourceId and tag parameters.'], + ['code' => 'ResourceIdIsIllegal', 'message' => 'The specified ResourceId is invalid.', 'http_code' => 400, 'description' => 'The parameter ResourceId is illegal.'], + ['code' => 'ResourceIdIsNull', 'message' => 'You must specify the resourceId parameter.', 'http_code' => 400, 'description' => 'You must specify the resourceId parameter.'], + ['code' => 'ResourceIDOUT', 'message' => 'the number of ResourceID is OUT', 'http_code' => 400, 'description' => 'The number of resource IDs exceeds the upper limit.'], + ['code' => 'ResourceIDOUT', 'message' => 'The specified resourceId number is out of range.', 'http_code' => 400, 'description' => 'The number of resource IDs exceeds the upper limit.'], + ['code' => 'ResourceTypeIllegal', 'message' => 'The ResourceType parameter is invalid.', 'http_code' => 400, 'description' => 'The specified ResourceType parameter is invalid.'], + ['code' => 'RetcodeDailyCustomLimit', 'message' => 'Usage today has exceeded the custom limit. The current operation is prohibited.', 'http_code' => 403, 'description' => 'Usage today has exceeded the custom limit. The current operation is prohibited.'], + ['code' => 'RetcodeDailyFreeLimit', 'message' => 'Usage today has exceeded the Essential Edition limit. The current operation is prohibited.', 'http_code' => 403, 'description' => 'Usage today has exceeded the Essential Edition limit. The current operation is prohibited.'], + ['code' => 'RetcodeTrialExpired', 'message' => 'The trial period of Browser Monitoring has expired. Please go to the console to activate Pay-As-You-Go for Browser Monitoring.', 'http_code' => 403, 'description' => 'The trial period of Browser Monitoring has expired. Please go to the console to activate Pay-As-You-Go for Browser Monitoring.'], + ['code' => 'RetcodeWaitForExpire', 'message' => 'The Browser Monitoring payment is overdue. Please try again after renewal.', 'http_code' => 403, 'description' => 'The Browser Monitoring payment is overdue. Please try again after renewal.'], + ['code' => 'RunningTaskNotExist', 'message' => 'Application data collection task does not exist or has been stopped.', 'http_code' => 404, 'description' => 'Application data collection task does not exist or has been stopped'], + ['code' => 'ScopeDisAgreement', 'message' => 'You must specify a consistent value for the scope parameter.', 'http_code' => 400, 'description' => 'You must specify a consistent value for the scope parameter.'], + ['code' => 'ScopeIsIllegal', 'message' => 'The specified Scope is invalid.', 'http_code' => 400, 'description' => 'The specified scope parameter is invalid.'], + ['code' => 'ServiceNameNotExist', 'message' => 'The ServiceName does not exist.', 'http_code' => 404, 'description' => 'The ServiceName does not exist.'], + ['code' => 'STSNotAuthorize', 'message' => 'STS authorization failed.', 'http_code' => 403, 'description' => 'STS authorization failed.'], + ['code' => 'STSNotAuthorize', 'message' => 'STS authentication failed because the caller is not authorized to perform the %s operation on the %s resource.', 'http_code' => 403, 'description' => 'STS authentication failed because the caller is not authorized to perform the %s operation on the %s resource.'], + ['code' => 'TagIsIllegal', 'message' => 'The TagKey or TagValue parameter is invalid.', 'http_code' => 400, 'description' => 'The specified tag key or tag value is invalid.'], + ['code' => 'TagISNull', 'message' => 'You must specify the tag parameter.', 'http_code' => 400, 'description' => 'You must specify the tag parameter.'], + ['code' => 'TagISNull', 'message' => 'param tag must be not null.', 'http_code' => 400, 'description' => ''], + ['code' => 'TagKeyIsIllegal', 'message' => 'The specified TagKey is invalid.', 'http_code' => 400, 'description' => 'The specified TagKey parameter is invalid.'], + ['code' => 'TagNumOUT', 'message' => 'The number of tags exceeds the upper limit.', 'http_code' => 400, 'description' => 'The number of tags exceeds the upper limit.'], + ['code' => 'TagValueIsIllegal', 'message' => 'The specified TagValue is invalid.', 'http_code' => 400, 'description' => 'The specified TagValue parameter is invalid.'], + ['code' => 'TraceTrialExpired', 'message' => 'The trial period of Application Monitoring has expired. Please go to the console to activate Pay-As-You-Go for Application Monitoring.', 'http_code' => 403, 'description' => 'The trial period of Application Monitoring has expired. Please go to the console to activate Pay-As-You-Go for Application Monitoring.'], + ['code' => 'TracingAnalysisNotAuthorize', 'message' => 'The current user has not authorized TracingAnalysis.', 'http_code' => 403, 'description' => 'The current user has not authorized TracingAnalysis.'], + ['code' => 'UserNotExist', 'message' => 'The user does not exist.', 'http_code' => 404, 'description' => 'The user does not exist.'], + ], + 'changeSet' => [ + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2025-12-01T02:27:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2025-03-13T02:37:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironmentFeature'], + ], + 'createdAt' => '2025-02-27T09:38:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMultipleTrace'], + ['description' => 'Request parameters changed', 'api' => 'GetTrace'], + ], + 'createdAt' => '2025-02-21T07:07:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRumApp'], + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ['description' => 'Request parameters changed', 'api' => 'UpdateRumApp'], + ], + 'createdAt' => '2025-02-17T02:03:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2025-02-13T10:22:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRumApps'], + ], + 'createdAt' => '2025-02-13T05:43:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAddonReleases'], + ], + 'createdAt' => '2025-01-21T08:49:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ['description' => 'Request parameters changed', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2025-01-10T10:16:58.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRumApp'], + ['description' => 'Request parameters changed', 'api' => 'GetRumAppInfo'], + ['description' => 'Request parameters changed', 'api' => 'GetRumApps'], + ['description' => 'Request parameters changed', 'api' => 'GetRumDataForPage'], + ], + 'createdAt' => '2025-01-07T03:51:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DoInsightsAction'], + ], + 'createdAt' => '2025-01-03T09:29:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2024-12-27T03:48:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRumExceptionStack'], + ], + 'createdAt' => '2024-12-20T02:42:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusInstance'], + ], + 'createdAt' => '2024-12-13T07:38:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGrafanaWorkspace'], + ], + 'createdAt' => '2024-12-06T03:21:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateGrafanaWorkspace'], + ], + 'createdAt' => '2024-12-05T08:20:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusInstance'], + ], + 'createdAt' => '2024-12-05T01:39:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumExceptionStack'], + ], + 'createdAt' => '2024-11-27T12:06:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumExceptionStack'], + ], + 'createdAt' => '2024-10-17T12:37:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetStack'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'SearchTraces'], + ['description' => 'Response parameters changed', 'api' => 'SearchTracesByPage'], + ], + 'createdAt' => '2024-10-08T03:40:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ], + 'createdAt' => '2024-09-29T03:17:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ['description' => 'Request parameters changed', 'api' => 'UpdateRumApp'], + ], + 'createdAt' => '2024-09-19T11:26:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ], + 'createdAt' => '2024-09-06T10:03:33.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRumApp'], + ['description' => 'Request parameters changed', 'api' => 'DeleteRumApp'], + ['description' => 'Request parameters changed', 'api' => 'UpdateRumApp'], + ], + 'createdAt' => '2024-09-02T10:54:06.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusInstance'], + ], + 'createdAt' => '2024-09-02T01:51:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListActivatedAlerts'], + ['description' => 'Response parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2024-08-26T05:57:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRumUploadFileUrl'], + ['description' => 'Request parameters changed', 'api' => 'GetRumAppInfo'], + ['description' => 'Request parameters changed', 'api' => 'GetRumDataForPage'], + ['description' => 'Request parameters changed', 'api' => 'GetRumOcuStatisticData'], + ['description' => 'Request parameters changed', 'api' => 'GetRumUploadFiles'], + ], + 'createdAt' => '2024-08-16T07:55:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMultipleTrace'], + ], + 'createdAt' => '2024-08-16T03:15:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteRumUploadFile'], + ], + 'createdAt' => '2024-08-15T12:30:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ], + 'createdAt' => '2024-08-15T08:24:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateSilencePolicy'], + ['description' => 'Response parameters changed', 'api' => 'ListSilencePolicies'], + ], + 'createdAt' => '2024-08-12T01:36:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ], + 'createdAt' => '2024-08-08T17:10:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ], + 'createdAt' => '2024-08-02T02:21:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DoInsightsAction'], + ], + 'createdAt' => '2024-07-31T03:43:54.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DoInsightsAction'], + ], + 'createdAt' => '2024-07-30T09:08:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateEventBridgeIntegration'], + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateIMRobot'], + ['description' => 'Request parameters changed', 'api' => 'DeleteEventBridgeIntegration'], + ['description' => 'Request parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2024-07-30T07:59:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListEnvironments'], + ], + 'createdAt' => '2024-07-26T06:38:51.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRumUploadFiles'], + ], + 'createdAt' => '2024-07-25T13:01:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'QueryCommercialUsage'], + ], + 'createdAt' => '2024-07-25T02:06:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateRumApp'], + ['description' => 'Request parameters changed', 'api' => 'GetRumApps'], + ], + 'createdAt' => '2024-07-12T06:35:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'StartAlert'], + ['description' => 'Error codes changed', 'api' => 'StopAlert'], + ], + 'createdAt' => '2024-07-12T01:47:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'Upload'], + ], + 'createdAt' => '2024-07-11T05:44:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ], + 'createdAt' => '2024-07-10T03:56:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ], + 'createdAt' => '2024-07-10T02:02:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ['description' => 'Request parameters changed', 'api' => 'UpdateRumApp'], + ], + 'createdAt' => '2024-07-03T08:03:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ], + 'createdAt' => '2024-07-03T01:58:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateRumApp'], + ['description' => 'Response parameters changed', 'api' => 'GetRumAppInfo'], + ], + 'createdAt' => '2024-06-28T09:11:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateDispatchRule'], + ['description' => 'Error codes changed', 'api' => 'DeleteDispatchRule'], + ], + 'createdAt' => '2024-06-21T08:19:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRumExceptionStack'], + ], + 'createdAt' => '2024-06-20T13:56:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CheckCommercialStatus'], + ['description' => 'Request parameters changed', 'api' => 'GetCommercialStatus'], + ], + 'createdAt' => '2024-06-20T02:58:18.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetAppApiByPage'], + ['description' => 'Error codes changed', 'api' => 'QueryMetricByPage'], + ], + 'createdAt' => '2024-06-19T09:14:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListDispatchRule'], + ['description' => 'Error codes changed', 'api' => 'ListPrometheusAlertTemplates'], + ['description' => 'Error codes changed', 'api' => 'SearchAlertContactGroup'], + ['description' => 'Error codes changed', 'api' => 'SearchEvents'], + ], + 'createdAt' => '2024-06-19T06:27:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateNotificationPolicy'], + ['description' => 'Response parameters changed', 'api' => 'ListNotificationPolicies'], + ], + 'createdAt' => '2024-06-19T03:09:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRetcodeAppByPid'], + ['description' => 'Request parameters changed', 'api' => 'Upload'], + ], + 'createdAt' => '2024-06-19T01:56:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ], + 'createdAt' => '2024-06-17T03:48:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateAlertContactGroup'], + ['description' => 'Error codes changed', 'api' => 'DeleteAlertContact'], + ['description' => 'Error codes changed', 'api' => 'DeleteAlertContactGroup'], + ], + 'createdAt' => '2024-06-14T01:32:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteAddonRelease'], + ['description' => 'Response parameters changed', 'api' => 'ListAddons'], + ], + 'createdAt' => '2024-06-07T08:51:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTraceApp'], + ], + 'createdAt' => '2024-05-30T02:27:09.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2024-05-29T11:57:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteTraceApp'], + ], + 'createdAt' => '2024-05-28T11:10:16.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ], + 'createdAt' => '2024-05-28T08:11:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetAppApiByPage'], + ['description' => 'Error codes changed', 'api' => 'QueryMetricByPage'], + ], + 'createdAt' => '2024-05-28T07:56:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ], + 'createdAt' => '2024-05-28T03:16:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ], + 'createdAt' => '2024-05-27T09:17:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ApplyScenario'], + ['description' => 'Error codes changed', 'api' => 'DeleteScenario'], + ], + 'createdAt' => '2024-05-27T02:54:10.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateSilencePolicy'], + ], + 'createdAt' => '2024-05-24T03:42:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateSilencePolicy'], + ['description' => 'Response parameters changed', 'api' => 'ListSilencePolicies'], + ], + 'createdAt' => '2024-05-24T01:44:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironmentFeature'], + ['description' => 'Request parameters changed', 'api' => 'ListEnvironmentFeatures'], + ], + 'createdAt' => '2024-05-23T02:56:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlertEvents'], + ], + 'createdAt' => '2024-05-11T09:01:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAlertEvents'], + ], + 'createdAt' => '2024-05-11T02:44:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateContact'], + ], + 'createdAt' => '2024-05-09T06:04:27.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateOrUpdateContact'], + ], + 'createdAt' => '2024-05-09T02:11:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ], + 'createdAt' => '2024-05-08T08:10:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeEnvironmentFeature'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListEnvironments'], + ], + 'createdAt' => '2024-05-07T08:31:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2024-05-07T07:36:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2024-04-29T05:48:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetRetcodeShareUrl'], + ], + 'createdAt' => '2024-04-15T07:05:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTimingSyntheticTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTimingSyntheticTask'], + ['description' => 'Response parameters changed', 'api' => 'ListTimingSyntheticTasks'], + ['description' => 'Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2024-04-12T06:36:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ], + 'createdAt' => '2024-04-12T03:45:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'TagResources'], + ], + 'createdAt' => '2024-04-11T06:57:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InitEnvironment'], + ], + 'createdAt' => '2024-04-03T10:41:34.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2024-04-02T02:23:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteAppList'], + ], + 'createdAt' => '2024-03-26T07:38:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateEnvironment'], + ], + 'createdAt' => '2024-03-22T06:16:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateEnvironment'], + ], + 'createdAt' => '2024-03-21T07:50:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ['description' => 'Request parameters changed', 'api' => 'UpdateEnvironment'], + ], + 'createdAt' => '2024-03-19T06:41:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTimingSyntheticTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTimingSyntheticTask'], + ['description' => 'Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2024-03-14T12:32:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTimingSyntheticTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTimingSyntheticTask'], + ['description' => 'Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2024-03-01T02:22:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ], + 'createdAt' => '2024-02-28T02:25:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ], + 'createdAt' => '2024-02-28T02:15:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateTimingSyntheticTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTimingSyntheticTask'], + ['description' => 'Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2024-02-23T06:26:15.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ], + 'createdAt' => '2024-02-23T02:07:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'Upload'], + ], + 'createdAt' => '2024-02-01T11:58:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateIntegration'], + ], + 'createdAt' => '2024-01-30T10:55:22.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ], + 'createdAt' => '2024-01-29T13:27:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListEnvironments'], + ], + 'createdAt' => '2024-01-29T08:21:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetAppApiByPage'], + ['description' => 'Error codes changed', 'api' => 'QueryMetricByPage'], + ], + 'createdAt' => '2024-01-25T11:00:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeAddonRelease'], + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironmentFeature'], + ['description' => 'Response parameters changed', 'api' => 'InstallAddon'], + ['description' => 'Response parameters changed', 'api' => 'ListAddonReleases'], + ['description' => 'Response parameters changed', 'api' => 'ListEnvironmentFeatures'], + ['description' => 'Response parameters changed', 'api' => 'ListEnvironments'], + ], + 'createdAt' => '2024-01-23T08:16:04.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetAgentDownloadUrl'], + ['description' => 'Error codes changed', 'api' => 'OpenXtraceDefaultSLR'], + ], + 'createdAt' => '2024-01-17T02:26:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InitEnvironment'], + ], + 'createdAt' => '2024-01-16T09:27:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ], + 'createdAt' => '2024-01-09T11:55:37.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2024-01-05T08:03:40.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2024-01-03T06:53:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetMultipleTrace'], + ], + 'createdAt' => '2023-12-21T11:58:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'QueryAppMetadata'], + ], + 'createdAt' => '2023-12-21T09:51:28.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2023-12-21T07:36:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-12-18T08:14:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ChangeResourceGroup'], + ], + 'createdAt' => '2023-12-14T07:44:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2023-12-14T07:26:36.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListPrometheusInstanceByTagAndResourceGroupId'], + ], + 'createdAt' => '2023-12-13T03:34:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2023-12-11T14:25:46.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2023-12-08T15:22:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2023-12-08T07:35:03.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetSyntheticMonitors'], + ['description' => 'Request parameters changed', 'api' => 'GetSyntheticTaskDetail'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'StopTimingSyntheticTask'], + ], + 'createdAt' => '2023-12-06T09:14:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2023-12-06T01:57:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CheckCommercialStatus'], + ], + 'createdAt' => '2023-11-21T02:24:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPrometheusInstances'], + ], + 'createdAt' => '2023-11-20T07:56:59.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetCommercialStatus'], + ], + 'createdAt' => '2023-11-17T06:31:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UninstallPromCluster'], + ], + 'createdAt' => '2023-11-16T11:19:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetManagedPrometheusStatus'], + ], + 'createdAt' => '2023-11-13T11:42:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteEnvironment'], + ], + 'createdAt' => '2023-11-13T02:12:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2023-11-07T09:50:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SaveTraceAppConfig'], + ], + 'createdAt' => '2023-11-06T08:27:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateEnvironment'], + ['description' => 'Response parameters changed', 'api' => 'DescribeEnvironment'], + ], + 'createdAt' => '2023-11-03T07:44:43.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'CreateTimingSyntheticTask'], + ['description' => 'Response parameters changed', 'api' => 'GetTimingSyntheticTask'], + ['description' => 'Error codes changed, Request parameters changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2023-10-26T12:34:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-10-20T04:59:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListInsightsEvents'], + ], + 'createdAt' => '2023-10-19T11:53:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-10-17T11:37:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-10-16T10:03:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListTraceApps'], + ], + 'createdAt' => '2023-10-13T03:18:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-10-11T08:09:26.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'OpenArmsServiceSecondVersion'], + ], + 'createdAt' => '2023-09-25T06:53:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SearchTraceAppByName'], + ], + 'createdAt' => '2023-09-18T08:43:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-09-14T13:00:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ConfigApp'], + ], + 'createdAt' => '2023-09-13T12:11:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UpdateAlertRule'], + ], + 'createdAt' => '2023-09-11T08:41:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTraceApps'], + ], + 'createdAt' => '2023-09-11T02:41:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ['description' => 'Request parameters changed', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2023-09-10T02:13:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateTimingSyntheticTask'], + ['description' => 'Error codes changed', 'api' => 'UpdateTimingSyntheticTask'], + ], + 'createdAt' => '2023-09-08T02:01:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteAppList'], + ], + 'createdAt' => '2023-09-07T02:52:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'Upload'], + ], + 'createdAt' => '2023-09-04T09:44:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2023-08-30T02:31:41.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteTimingSyntheticTask'], + ], + 'createdAt' => '2023-08-24T12:37:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DeleteTimingSyntheticTask'], + ], + 'createdAt' => '2023-08-24T12:11:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2023-08-24T05:40:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DeleteAlertRules'], + ], + 'createdAt' => '2023-08-22T02:32:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateNotificationPolicy'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListAlerts'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListNotificationPolicies'], + ], + 'createdAt' => '2023-08-17T11:54:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusGlobalView'], + ], + 'createdAt' => '2023-08-17T02:09:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'QueryMetricByPage'], + ['description' => 'Error codes changed', 'api' => 'SaveTraceAppConfig'], + ], + 'createdAt' => '2023-08-14T12:01:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusGlobalView'], + ], + 'createdAt' => '2023-08-11T08:03:47.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTraceApps'], + ], + 'createdAt' => '2023-08-09T03:34:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListScenario'], + ], + 'createdAt' => '2023-08-07T09:22:32.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddGrafana'], + ], + 'createdAt' => '2023-08-04T07:01:49.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusGlobalView'], + ], + 'createdAt' => '2023-08-04T01:52:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteTraceApp'], + ], + 'createdAt' => '2023-08-03T03:18:38.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SaveTraceAppConfig'], + ], + 'createdAt' => '2023-08-03T03:16:30.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddPrometheusRemoteWrite'], + ], + 'createdAt' => '2023-08-03T02:09:29.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreatePrometheusAlertRule'], + ['description' => 'Response parameters changed', 'api' => 'DeletePrometheusAlertRule'], + ['description' => 'Response parameters changed', 'api' => 'DescribePrometheusAlertRule'], + ['description' => 'Response parameters changed', 'api' => 'ListPrometheusAlertRules'], + ['description' => 'Response parameters changed', 'api' => 'UpdatePrometheusAlertRule'], + ], + 'createdAt' => '2023-07-31T01:54:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'CreateRetcodeApp'], + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'DeleteRetcodeApp'], + ], + 'createdAt' => '2023-07-27T11:22:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'ImportAppAlertRules'], + ['description' => 'Request parameters changed', 'api' => 'SearchAlertRules'], + ], + 'createdAt' => '2023-07-14T01:53:20.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DeletePrometheusAlertRule'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribePrometheusAlertRule'], + ], + 'createdAt' => '2023-07-14T01:44:21.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRetcodeAppByPid'], + ], + 'createdAt' => '2023-06-28T03:20:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchTraceAppByName'], + ], + 'createdAt' => '2023-06-25T09:49:08.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetTraceApp'], + ['description' => 'Request parameters changed', 'api' => 'UntagResources'], + ], + 'createdAt' => '2023-06-25T02:29:17.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPrometheusInstanceByTagAndResourceGroupId'], + ], + 'createdAt' => '2023-06-21T07:14:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UpdateIntegration'], + ], + 'createdAt' => '2023-06-12T09:34:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetAppApiByPage'], + ['description' => 'Response parameters changed', 'api' => 'QueryMetricByPage'], + ], + 'createdAt' => '2023-06-09T02:45:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusMonitoring'], + ], + 'createdAt' => '2023-05-26T03:37:13.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusMonitoring'], + ], + 'createdAt' => '2023-05-26T03:16:48.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusMonitoring'], + ], + 'createdAt' => '2023-05-26T03:05:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2023-05-25T09:03:23.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusMonitoring'], + ['description' => 'Response parameters changed', 'api' => 'ListPrometheusMonitoring'], + ], + 'createdAt' => '2023-05-25T02:07:12.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SearchAlertRules'], + ], + 'createdAt' => '2023-05-18T01:55:19.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPrometheusInstanceByTagAndResourceGroupId'], + ], + 'createdAt' => '2023-05-17T09:15:24.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetManagedPrometheusStatus'], + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ['description' => 'Request parameters changed', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2023-05-15T03:16:14.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'TagResources'], + ['description' => 'Response parameters changed', 'api' => 'UntagResources'], + ], + 'createdAt' => '2023-05-12T01:53:56.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2023-05-11T12:21:52.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreatePrometheusAlertRule'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetAlertRules'], + ['description' => 'Request parameters changed, Response parameters changed, Error codes changed', 'api' => 'ListPrometheusAlertRules'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UpdatePrometheusAlertRule'], + ], + 'createdAt' => '2023-05-11T12:16:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusMonitoring'], + ], + 'createdAt' => '2023-05-09T05:41:25.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'DescribeContactGroups'], + ['description' => 'Request parameters changed', 'api' => 'DescribeContacts'], + ], + 'createdAt' => '2023-04-28T08:33:44.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'TagResources'], + ], + 'createdAt' => '2023-04-23T07:57:42.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'OpenArmsDefaultSLR'], + ], + 'createdAt' => '2023-04-21T08:40:31.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListPrometheusInstances'], + ], + 'createdAt' => '2023-04-21T05:38:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetPrometheusIntegration'], + ], + 'createdAt' => '2023-04-10T08:18:53.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListPrometheusInstanceByTagAndResourceGroupId'], + ], + 'createdAt' => '2023-03-30T09:15:39.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateNotificationPolicy'], + ['description' => 'Response parameters changed', 'api' => 'ListNotificationPolicies'], + ], + 'createdAt' => '2023-03-30T06:16:35.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreatePrometheusInstance'], + ['description' => 'Request parameters changed', 'api' => 'UpdatePrometheusGlobalView'], + ], + 'createdAt' => '2023-03-29T09:03:00.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'OpenArmsServiceSecondVersion'], + ], + 'createdAt' => '2023-03-27T11:01:57.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ChangeResourceGroup'], + ], + 'createdAt' => '2023-03-27T07:22:45.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'TagResources'], + ['description' => 'Response parameters changed', 'api' => 'UntagResources'], + ], + 'createdAt' => '2023-03-24T08:23:11.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SearchTracesByPage'], + ], + 'createdAt' => '2023-03-24T08:22:50.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddAliClusterIdsToPrometheusGlobalView'], + ['description' => 'Response parameters changed', 'api' => 'AddIntegration'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'AddPrometheusGlobalView'], + ['description' => 'Response parameters changed', 'api' => 'AddPrometheusGlobalViewByAliClusterIds'], + ['description' => 'Response parameters changed', 'api' => 'AddRecordingRule'], + ['description' => 'Response parameters changed', 'api' => 'AppendInstancesToPrometheusGlobalView'], + ['description' => 'Response parameters changed', 'api' => 'DeleteGrafanaResource'], + ['description' => 'Response parameters changed', 'api' => 'DeleteIntegration'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'DeletePrometheusGlobalView'], + ], + 'createdAt' => '2023-03-24T08:21:05.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetPrometheusApiToken'], + ], + 'createdAt' => '2023-03-24T08:21:02.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddPrometheusInstance'], + ['description' => 'Response parameters changed', 'api' => 'GetAuthToken'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'GetCloudClusterAllUrl'], + ['description' => 'Response parameters changed', 'api' => 'GetClusterAllUrl'], + ['description' => 'Response parameters changed', 'api' => 'GetExploreUrl'], + ], + 'createdAt' => '2023-03-24T08:20:07.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetPrometheusIntegration'], + ], + 'createdAt' => '2023-03-24T08:20:01.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'ListClusterFromGrafana'], + ['description' => 'Error codes changed', 'api' => 'QueryPromInstallStatus'], + ], + 'createdAt' => '2023-03-24T08:19:55.000Z', + 'description' => '', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2023-01-09T02:51:16.000Z', + 'description' => '支持预发环境', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DeleteRetcodeApp'], + ], + 'createdAt' => '2023-01-05T06:44:15.000Z', + 'description' => 'DeleteRetcodeApp变更', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DeletePrometheusGlobalView'], + ], + 'createdAt' => '2023-01-03T06:54:14.000Z', + 'description' => 'Prometheus关联api发布', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetTraceApp'], + ], + 'createdAt' => '2023-01-03T03:48:18.000Z', + 'description' => 'GetTraceApp相关接口更新', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed, Response parameters changed', 'api' => 'GetTraceApp'], + ['description' => 'Response parameters changed', 'api' => 'ListTraceApps'], + ['description' => 'Response parameters changed, Response parameters changed', 'api' => 'SearchTraceAppByName'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchTraceAppByPage'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'SetRetcodeShareStatus'], + ], + 'createdAt' => '2023-01-03T03:38:34.000Z', + 'description' => 'TraceApp及RetcodeApp相关接口发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DeleteRetcodeApp'], + ], + 'createdAt' => '2022-12-29T09:41:32.000Z', + 'description' => '修改DeleteRetcodeApp接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddPrometheusGlobalView'], + ], + 'createdAt' => '2022-12-29T06:38:28.000Z', + 'description' => '规范List Api命名', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateContact'], + ], + 'createdAt' => '2022-12-29T06:36:18.000Z', + 'description' => 'AlertContact资源及相关接口发布', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListRetcodeApps'], + ], + 'createdAt' => '2022-12-28T05:52:25.000Z', + 'description' => 'ListRetcodeApps返回增加标签', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'AddPrometheusGlobalView'], + ], + 'createdAt' => '2022-12-27T13:02:45.000Z', + 'description' => '资源组相关api上线', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListRetcodeApps'], + ], + 'createdAt' => '2022-12-27T12:47:12.000Z', + 'description' => 'ListRetCodeApp支持标签', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateRetcodeApp'], + ], + 'createdAt' => '2022-12-27T07:45:36.000Z', + 'description' => '更新retcodeApp和createApp创建相关接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'AddPrometheusRemoteWrite'], + ], + 'createdAt' => '2022-12-27T01:45:29.000Z', + 'description' => '增加remote write配置时，返回增加的remote write名称', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateRetcodeApp'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'SearchRetcodeAppByPage'], + ], + 'createdAt' => '2022-12-26T08:03:06.000Z', + 'description' => '更新RetcodeApp相关接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListRetcodeApps'], + ], + 'createdAt' => '2022-12-26T07:42:22.000Z', + 'description' => '更新RetcodeApp相关接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'SearchTraceAppByName'], + ], + 'createdAt' => '2022-12-23T04:55:49.000Z', + 'description' => 'SearchTraceAppByName增加regionId参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateAlertContact'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'SearchAlertContact'], + ], + 'createdAt' => '2022-12-23T04:13:15.000Z', + 'description' => '更新AlertContact相关接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ConfigApp'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DeleteTraceApp'], + ], + 'createdAt' => '2022-12-22T06:57:55.000Z', + 'description' => 'TraceApp资源发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetTraceApp'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'ListTraceApps'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'SearchTraceAppByName'], + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'SearchTraceAppByPage'], + ], + 'createdAt' => '2022-12-21T09:06:48.000Z', + 'description' => '发布TraceApp相关接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'GetMultipleTrace'], + ['description' => 'Request parameters changed', 'api' => 'GetTrace'], + ], + 'createdAt' => '2022-12-15T12:41:46.000Z', + 'description' => '增加事件查询上报接口修改调用链查询bug', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateContact'], + ], + 'createdAt' => '2022-12-07T08:57:08.000Z', + 'description' => 'EventBridge支持金融云', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2022-12-06T07:20:36.000Z', + 'description' => '明确3个必填参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2022-12-02T07:41:43.000Z', + 'description' => '明确vpcId、vSwitchId、securityGroupId为必填', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetTraceApp'], + ], + 'createdAt' => '2022-11-29T06:08:31.000Z', + 'description' => 'GetTraceApp返回新增tags', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetManagedPrometheusStatus'], + ['description' => 'Request parameters changed', 'api' => 'GetManagedPrometheusStatus'], + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2022-11-28T11:43:05.000Z', + 'description' => '明确InstallManagedPrometheus和GetManagedPrometheusStatus的特定入参为必填', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeContactGroups'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'DescribeContacts'], + ['description' => 'Request parameters changed', 'api' => 'DescribeIMRobots'], + ['description' => 'Request parameters changed', 'api' => 'DescribeWebhookContacts'], + ['description' => 'Request parameters changed', 'api' => 'ListNotificationPolicies'], + ], + 'createdAt' => '2022-11-17T08:08:47.000Z', + 'description' => '-支持Flink升级到新版arms pop', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateContact'], + ['description' => 'Response parameters changed', 'api' => 'DescribeContacts'], + ], + 'createdAt' => '2022-11-17T07:47:16.000Z', + 'description' => '新增联系人邮箱认证', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'DescribeTraceLicenseKey'], + ], + 'createdAt' => '2022-11-17T02:45:25.000Z', + 'description' => '支持token方式进行调用', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetRetcodeLogstore'], + ], + 'createdAt' => '2022-11-15T08:33:40.000Z', + 'description' => 'GetRetcodeLogstore', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'SearchRetcodeAppByPage'], + ], + 'createdAt' => '2022-11-14T11:08:14.000Z', + 'description' => '发布', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateIntegration'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteIntegrations'], + ], + 'createdAt' => '2022-10-17T02:12:31.000Z', + 'description' => 'ADD ARMSManager Integration API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListDashboardsByName'], + ], + 'createdAt' => '2022-10-17T02:12:22.000Z', + 'description' => '更新prometheus产品之ListDashBoardsByName接口，提供只查询大盘的控制字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateContact'], + ['description' => 'Response parameters changed', 'api' => 'DescribeContacts'], + ], + 'createdAt' => '2022-10-17T02:12:21.000Z', + 'description' => 'Update ARMSManager New Param', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetClusterAllUrl'], + ], + 'createdAt' => '2022-10-17T02:12:19.000Z', + 'description' => '新增Prometheus产品之GetClusterAllUrl接口，用于调用获取集群的数据源的读写路径等', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'Upload'], + ], + 'createdAt' => '2022-10-17T02:12:19.000Z', + 'description' => '更新Upload', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UninstallPromCluster'], + ], + 'createdAt' => '2022-09-29T11:41:09.000Z', + 'description' => 'Prometheus', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2022-09-28T10:13:08.000Z', + 'description' => '增大限流上限', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'AddIntegration'], + ], + 'createdAt' => '2022-09-23T02:22:20.000Z', + 'description' => 'Prometheus', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetSyntheticTaskDetail'], + ], + 'createdAt' => '2022-09-22T07:29:28.000Z', + 'description' => '修改GetSyntheticTaskDetail', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeIMRobots'], + ], + 'createdAt' => '2022-09-21T09:10:53.000Z', + 'description' => '添加钉钉签名返回字段。', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'ListRetcodeApps'], + ], + 'createdAt' => '2022-09-21T08:53:50.000Z', + 'description' => '修改ListRetcodeApp', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateIMRobot'], + ['description' => 'Response parameters changed', 'api' => 'ListAlertEvents'], + ], + 'createdAt' => '2022-09-20T08:39:05.000Z', + 'description' => '新增钉钉签名参数。', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'GetExploreUrl'], + ['description' => 'Error codes changed', 'api' => 'GetExploreUrl'], + ], + 'createdAt' => '2022-09-13T03:39:07.000Z', + 'description' => '- GetExploreUrl接口动态后端地址变更为售卖区', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2022-09-05T10:26:06.000Z', + 'description' => '增加产品编码', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2022-09-05T08:40:28.000Z', + 'description' => '增加按照集群查询告警规则功能', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2022-09-02T08:42:45.000Z', + 'description' => '修复问题', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'SyncRecordingRules'], + ], + 'createdAt' => '2022-09-02T03:08:42.000Z', + 'description' => 'Prometheus产品之发布SyncRecordingRules Api，用于用户将某个集群的聚合规则批量同步到全Region的其他集群', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListCmsInstances'], + ], + 'createdAt' => '2022-09-01T02:45:51.000Z', + 'description' => 'ListCmsInstances接口添加typeFilter参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetManagedPrometheusStatus'], + ], + 'createdAt' => '2022-08-25T15:26:01.000Z', + 'description' => '增加ASK集群安装prometheus状态查询', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListAlertEvents'], + ], + 'createdAt' => '2022-08-25T12:11:32.000Z', + 'description' => '-新增ListAlertEvents接口，可以查询告警事件历史。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSyntheticTask'], + ['description' => 'OpenAPI offline', 'api' => 'GetSyntheticTaskList'], + ['description' => 'OpenAPI offline', 'api' => 'SwitchSyntheticTaskStatus'], + ], + 'createdAt' => '2022-08-25T11:32:49.000Z', + 'description' => '新增云拨测POP接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSyntheticTask'], + ], + 'createdAt' => '2022-08-12T06:48:51.000Z', + 'description' => '更新CreateSyntheticTask', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateSyntheticTask'], + ], + 'createdAt' => '2022-08-11T12:15:10.000Z', + 'description' => '修改CreateSyntheticTask', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListIntegration'], + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'UpdateIntegration'], + ], + 'createdAt' => '2022-08-11T08:17:13.000Z', + 'description' => 'add new params alertmanager', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListIntegration'], + ['description' => 'Request parameters changed', 'api' => 'UpdateIntegration'], + ], + 'createdAt' => '2022-08-11T02:45:22.000Z', + 'description' => 'update alertManager Integration Api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddPrometheusInstance'], + ], + 'createdAt' => '2022-07-29T03:16:00.000Z', + 'description' => 'Prometheus产品之增加创建普通监控集群之接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetSourceMapInfo'], + ], + 'createdAt' => '2022-07-27T08:48:47.000Z', + 'description' => '更新GetSourceMapInfo OpenAPI', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteSourceMap'], + ['description' => 'OpenAPI offline', 'api' => 'GetSyntheticTaskMonitors'], + ], + 'createdAt' => '2022-07-26T12:41:20.000Z', + 'description' => '新增SourceMap相关OpenAPI接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetOnCallSchedulesDetail'], + ], + 'createdAt' => '2022-07-26T12:39:04.000Z', + 'description' => 'alertmanager add new api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateSyntheticTask'], + ], + 'createdAt' => '2022-07-22T04:01:27.000Z', + 'description' => '增加批量创建云拨测任务的POP接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListInsightsEvents'], + ], + 'createdAt' => '2022-07-22T03:37:39.000Z', + 'description' => '修改getdas事件', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateNotificationPolicy'], + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateSilencePolicy'], + ], + 'createdAt' => '2022-07-20T13:43:23.000Z', + 'description' => '通知策略全球同步，增加内部接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateIMRobot'], + ], + 'createdAt' => '2022-07-20T08:56:45.000Z', + 'description' => 'CreateOrUpdateIMRobot接口新增卡片模版字段', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'CreateRetcodeApp'], + ], + 'createdAt' => '2022-07-19T09:58:28.000Z', + 'description' => '更新CreateRetcodeApp的超时时间', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListSilencePolicies'], + ], + 'createdAt' => '2022-07-13T14:51:24.000Z', + 'description' => ' 增加regionId入参，不影响客户sdk使用', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListNotificationPolicies'], + ], + 'createdAt' => '2022-07-13T14:40:47.000Z', + 'description' => '增加regionId传递到后端，不影响用户sdk', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListPrometheusInstances'], + ], + 'createdAt' => '2022-07-11T07:49:58.000Z', + 'description' => 'Prometheus产品之新增获取Prometheus监控实例接口（ListPrometheusInstances）', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateIMRobot'], + ], + 'createdAt' => '2022-07-08T07:50:38.000Z', + 'description' => 'IM联系人POP接口新增字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallCmsExporter'], + ['description' => 'Response parameters changed', 'api' => 'ListCmsInstances'], + ], + 'createdAt' => '2022-06-16T06:20:49.000Z', + 'description' => 'InstallCmsExporter接口新增directArgs参数ListCmsInstances接口返回值新增source字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetClusterInfoForArms'], + ], + 'createdAt' => '2022-06-14T09:20:56.000Z', + 'description' => '更新GetClusterInfoForArms接口返回值', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DelAuthToken'], + ['description' => 'OpenAPI offline', 'api' => 'ListDashboardsByName'], + ], + 'createdAt' => '2022-06-10T08:31:39.000Z', + 'description' => '发布Prometheus产品之ListDashboardsByName接口；供多数据源用户调用并创建多数据源相关大盘', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'Upload'], + ], + 'createdAt' => '2022-06-07T12:20:10.000Z', + 'description' => '更新Upload', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'DescribeWebhookContacts'], + ], + 'createdAt' => '2022-05-27T06:39:22.000Z', + 'description' => 'update DescribeWebhookContacts params', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'AddPrometheusGlobalViewByAliClusterIds'], + ['description' => 'Request parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2022-05-20T03:24:02.000Z', + 'description' => 'prometheus产品下ListDashboards、AddPrometheusGlobalViewByAliClusterIds接口升级', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'RegisterCloudProduct'], + ], + 'createdAt' => '2022-05-19T12:26:31.000Z', + 'description' => '新增注册云产品接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateWebhook'], + ['description' => 'Request parameters changed', 'api' => 'UpdateWebhook'], + ], + 'createdAt' => '2022-05-16T02:41:48.000Z', + 'description' => 'update alertmanage api params', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2022-05-10T11:40:25.000Z', + 'description' => 'prometheus产品listDashboards接口之返回大盘信息中添加了大盘语言环境字段', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'ListDashboards'], + ], + 'createdAt' => '2022-05-10T11:40:24.000Z', + 'description' => 'prometheus listDashBoards Api升级之返回值中添加英文大盘', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'DescribeDispatchRule'], + ], + 'createdAt' => '2022-05-06T03:53:44.000Z', + 'description' => 'update arms manager DescribeDispatchRule api', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2022-04-27T09:07:43.000Z', + 'description' => 'API部分参数允许为空', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2022-04-26T12:28:18.000Z', + 'description' => 'Prometheus For ASK 功能,部分参数允许为空', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteCmsExporter'], + ['description' => 'OpenAPI offline', 'api' => 'InstallCmsExporter'], + ['description' => 'OpenAPI offline', 'api' => 'ListCmsInstances'], + ], + 'createdAt' => '2022-04-22T09:40:49.000Z', + 'description' => '新增CMS相关3个接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ManageGetRecordingRule'], + ], + 'createdAt' => '2022-04-22T06:18:57.000Z', + 'description' => '增加Prometheus管理员获取集群recordingRule API', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateIMRobot'], + ['description' => 'Request parameters changed', 'api' => 'CreateOrUpdateWebhookContact'], + ], + 'createdAt' => '2022-04-21T15:55:36.000Z', + 'description' => 'webhook、机器人创建接口字段非必填', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddAliClusterIdsToPrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'AddPrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'AddPrometheusGlobalViewByAliClusterIds'], + ['description' => 'OpenAPI offline', 'api' => 'AppendInstancesToPrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'DeletePrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'GetPrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'ListPrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'RemoveAliClusterIdsFromPrometheusGlobalView'], + ['description' => 'OpenAPI offline', 'api' => 'RemoveSourcesFromPrometheusGlobalView'], + ], + 'createdAt' => '2022-04-20T06:14:23.000Z', + 'description' => 'prometheus globalView聚合源能力相关接口的发布', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'SaveTraceAppConfig'], + ], + 'createdAt' => '2022-04-19T03:33:02.000Z', + 'description' => '更新Upload接口', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'CreateOrUpdateEventBridgeIntegration'], + ], + 'createdAt' => '2022-04-19T03:32:51.000Z', + 'description' => 'update arms manager eventbridge param', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'Upload'], + ], + 'createdAt' => '2022-04-19T03:32:50.000Z', + 'description' => '更新Upload接口为public', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'QueryTraces'], + ['description' => 'OpenAPI offline', 'api' => 'SearchTagNames'], + ['description' => 'OpenAPI offline', 'api' => 'SearchTagValues'], + ], + 'createdAt' => '2022-04-01T02:19:35.000Z', + 'description' => '新增Tempo相关的OpenAPI接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListTagResources'], + ['description' => 'OpenAPI offline', 'api' => 'TagResources'], + ['description' => 'OpenAPI offline', 'api' => 'UntagResources'], + ], + 'createdAt' => '2022-03-25T07:27:26.000Z', + 'description' => 'tag标签操作API', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ExploreTrace'], + ], + 'createdAt' => '2022-03-24T13:00:53.000Z', + 'description' => '新增接口', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'UpdateAlertContactGroup'], + ], + 'createdAt' => '2022-03-17T07:57:03.000Z', + 'description' => 'update UpdateAlertContactGroup api address', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'SearchAlertRules'], + ], + 'createdAt' => '2022-03-14T11:23:13.000Z', + 'description' => 'Update SearchAlertRules', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'SearchTraces'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'SearchTracesByPage'], + ], + 'createdAt' => '2022-03-04T03:40:55.000Z', + 'description' => 'SearchTraces/SearchTracesByPage接口增加新的参数', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetAuthToken'], + ], + 'createdAt' => '2022-02-25T06:35:24.000Z', + 'description' => '增加获取grafana dataSource的url的获取鉴权的路径', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ManageRecordingRule'], + ], + 'createdAt' => '2022-02-25T06:33:08.000Z', + 'description' => '增加RecoringRule的多用户操作api', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetClusterInfo'], + ], + 'createdAt' => '2022-02-25T02:58:57.000Z', + 'description' => 'GetClusterInfo返参优化', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateNotificationPolicy'], + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateSilencePolicy'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteNotificationPolicy'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteSilencePolicy'], + ['description' => 'OpenAPI offline', 'api' => 'ListEscalationPolicies'], + ['description' => 'OpenAPI offline', 'api' => 'ListNotificationPolicies'], + ['description' => 'OpenAPI offline', 'api' => 'ListOnCallSchedules'], + ['description' => 'OpenAPI offline', 'api' => 'ListSilencePolicies'], + ], + 'createdAt' => '2022-02-24T13:11:42.000Z', + 'description' => 'Add New NotificationPolicy', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteIntegration'], + ['description' => 'OpenAPI offline', 'api' => 'GetIntegrationState'], + ], + 'createdAt' => '2022-01-21T06:07:44.000Z', + 'description' => 'prometheus增加Integration接入的状态查询接口和删除接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'ListAlerts'], + ], + 'createdAt' => '2022-01-14T03:48:37.000Z', + 'description' => 'Arms监控告警管理告警发送历史pop接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetClusterState'], + ], + 'createdAt' => '2022-01-13T15:00:03.000Z', + 'description' => 'prometheus获取集群状态', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2022-01-07T12:50:18.000Z', + 'description' => '更新获取告警接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddASMIntegration'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteASMIntegration'], + ['description' => 'OpenAPI offline', 'api' => 'GetASMIntegrationState'], + ], + 'createdAt' => '2022-01-07T06:13:16.000Z', + 'description' => '公共版prometheus增加Integration接入ASM的api', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateContact'], + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateContactGroup'], + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateIMRobot'], + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateWebhookContact'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteContact'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteContactGroup'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteIMRobot'], + ['description' => 'OpenAPI offline', 'api' => 'DeleteWebhookContact'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeContactGroups'], + ['description' => 'OpenAPI offline', 'api' => 'DescribeContacts'], + ], + 'createdAt' => '2022-01-06T13:25:38.000Z', + 'description' => '添加联系人接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'DeleteAlertRule'], + ], + 'createdAt' => '2022-01-06T13:21:03.000Z', + 'description' => '删除告警规则接口', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2022-01-04T08:53:39.000Z', + 'description' => '对内部给其他产品使用,暂不对外,无需公示', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2022-01-04T08:41:26.000Z', + 'description' => '对内部给其他产品使用,暂不对外,无需公示', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'UninstallManagedPrometheus'], + ], + 'createdAt' => '2022-01-04T07:51:44.000Z', + 'description' => '本接口目前提供给内部其他云产品使用,暂不对外透出.', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'InstallManagedPrometheus'], + ], + 'createdAt' => '2022-01-04T07:23:12.000Z', + 'description' => '此次API提供给内部其他云产品调用,暂不需要对外公示', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetClusterState'], + ], + 'createdAt' => '2021-12-31T02:12:21.000Z', + 'description' => 'prometheus获取集群状态', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2021-12-28T06:08:42.000Z', + 'description' => '修正类型', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'CreateOrUpdateAlertRule'], + ], + 'createdAt' => '2021-12-22T06:04:36.000Z', + 'description' => '更新字段', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Response parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2021-12-17T09:24:49.000Z', + 'description' => '完善字段值', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2021-12-08T08:03:29.000Z', + 'description' => '增加分页接口', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetAlertRules'], + ], + 'createdAt' => '2021-12-07T15:34:43.000Z', + 'description' => '增加新版告警规则查询接口，支持同时查询新旧版本告警规则。', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'ListDashboards'], + ['description' => 'Request parameters changed', 'api' => 'QueryMetricByPage'], + ], + 'createdAt' => '2021-11-26T03:16:59.000Z', + 'description' => 'API字段可见性修改', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'AddRecordingRule'], + ['description' => 'OpenAPI offline', 'api' => 'GetRecordingRule'], + ], + 'createdAt' => '2021-11-19T06:36:59.000Z', + 'description' => '新建api的发布，之前没有调用关系，可以直接发布', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed', 'api' => 'QueryMetricByPage'], + ], + 'createdAt' => '2021-11-18T05:36:30.000Z', + 'description' => 'customfilters可见性', + ], + [ + 'apis' => [ + ['description' => 'Error codes changed', 'api' => 'OpenArmsServiceSecondVersion'], + ], + 'createdAt' => '2021-11-01T11:43:24.000Z', + 'description' => 'OpenArmsServiceSecondVersion增加stsTokenCallerBid系统参数', + ], + [ + 'apis' => [ + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'CreateWebhook'], + ['description' => 'Request parameters changed, Error codes changed', 'api' => 'UpdateWebhook'], + ], + 'createdAt' => '2021-10-29T02:43:48.000Z', + 'description' => '- Webhook支持配置告警恢复模板', + ], + [ + 'apis' => [ + ['description' => 'Response parameters changed, Error codes changed', 'api' => 'GetTrace'], + ], + 'createdAt' => '2021-10-28T03:09:18.000Z', + 'description' => '透传children trace', + ], + [ + 'apis' => [ + ['description' => 'OpenAPI offline', 'api' => 'GetEstimateFeeInfo'], + ], + 'createdAt' => '2021-08-18T09:13:02.000Z', + 'description' => 'GetEstimateFeeInfo', + ], + ], + 'flowControl' => [ + 'flowControlList' => [ + ['threshold' => '-1', 'countWindow' => 1, 'regionId' => '*'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddonReleases'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvPodMonitor'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UntagResources'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusInstance'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRetcodeAppByPid'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListClusterFromGrafana'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusAlertRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContactGroup'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallManagedPrometheus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvCustomJob'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteTimingSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeAlarmSeverity'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticTaskMonitors'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeAddonRelease'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvironment'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenVCluster'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvPodMonitor'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEventBridgeIntegrations'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSourceMap'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvServiceMonitor'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BlockAlarmNotification'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateSilencePolicy'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListCmsInstances'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StopTimingSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvironmentDashboards'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateGrafanaWorkspace'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetManagedPrometheusStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateMetricDrop'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAddons'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvCustomJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveAliClusterIdsFromPrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddAliClusterIdsToPrometheusGlobalView'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'TagResources'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticTaskList'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEventBridgeIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlertEvents'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddGrafana'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetOnCallSchedulesDetail'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAlertRules'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvServiceMonitor'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateTimingSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AppendInstancesToPrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteNotificationPolicy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGrafanaWorkspace'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRetcodeDataByQuery'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIMRobot'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusAlertRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListNotificationPolicies'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallManagedPrometheus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvServiceMonitor'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'StartTimingSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddIntegration'], + ['threshold' => '2', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstanceByTagAndResourceGroupId'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SendTTSVerifyLink'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvironmentFeatures'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusMonitoring'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteWebhookContact'], + ['threshold' => '3000', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAppApiByPage'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryReleaseMetric'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallEnvironmentFeature'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusInstances'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetTimingSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGrafanaWorkspaceVersion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateWebhookContact'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpgradeEnvironmentFeature'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAddonRelease'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSilencePolicy'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SyncRecordingRules'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticTaskDetail'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAlertContactGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContactGroups'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvironment'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusMonitoring'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetIntegrationState'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvPodMonitors'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteCmsExporter'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSyntheticMonitors'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlertRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusMonitoring'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallAddon'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'OpenArmsServiceSecondVersion'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeWebhookContacts'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RestartEnvironmentFeature'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateContact'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvCustomJobs'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListOnCallSchedules'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusApiToken'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateAlertRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusAlertRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ClaimAlarm'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDashboards'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'EnableMetric'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'BindPrometheusGrafanaInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSilencePolicies'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CloseAlarm'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'RemoveSourcesFromPrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddTagToFlinkCluster'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeIMRobots'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusAlertRule'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAuthToken'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvCustomJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateEnvPodMonitor'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusGlobalViewByAliClusterIds'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchAlertContact'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteGrafanaResource'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CheckServiceStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateIMRobot'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'Upload'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetAlertRules'], + ['threshold' => '200', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryPromInstallStatus'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetSourceMapInfo'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SwitchSyntheticTaskStatus'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateTimingSyntheticTask'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateContactGroup'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCommercialStatus'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvServiceMonitor'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusIntegration'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRetcodeLogstore'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddPrometheusGlobalView'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ChangeResourceGroup'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateEventBridgeIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListGrafanaWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListAlerts'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'AddRecordingRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateEnvironment'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeletePrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvPodMonitor'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvironment'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvironmentFeature'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetClusterAllUrl'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusMonitoring'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InitEnvironment'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateOrUpdateNotificationPolicy'], + ['threshold' => '30', 'countWindow' => 1, 'regionId' => '*', 'api' => 'SearchTracesByPage'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetRecordingRule'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusMonitoringStatus'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UninstallPromCluster'], + ['threshold' => '100', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryAppMetadata'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetExploreUrl'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvironments'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DelAuthToken'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusAlertTemplates'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdatePrometheusMonitoring'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribePrometheusAlertRule'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusIntegration'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListTimingSyntheticTasks'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeEnvCustomJob'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreateIntegration'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEscalationPolicies'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListPrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetCloudClusterAllUrl'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetGrafanaWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetPrometheusGlobalView'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListEnvServiceMonitors'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'UpdateGrafanaWorkspace'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteEnvironmentFeature'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListDashboardsByName'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'GetStack'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeAddonRelease'], + ['threshold' => '10', 'countWindow' => 1, 'regionId' => '*', 'api' => 'CreatePrometheusInstance'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteContact'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DescribeContacts'], + ['threshold' => '50', 'countWindow' => 1, 'regionId' => '*', 'api' => 'ListSyntheticDetail'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteIntegrations'], + ['threshold' => '500', 'countWindow' => 1, 'regionId' => '*', 'api' => 'QueryMetricByPage'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'InstallCmsExporter'], + ['threshold' => '20', 'countWindow' => 1, 'regionId' => '*', 'api' => 'DeleteAlertRules'], + ], + ], + 'ram' => [ + 'productCode' => 'ARMS', + 'productName' => 'Application Real-Time Monitoring Service', + 'ramCodes' => ['arms', 'xtrace'], + 'ramLevel' => 'RESOURCE', + 'ramConditions' => [], + 'ramActions' => [ + [ + 'apiName' => 'GetAgentDownloadUrlV2', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAgentDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DeleteSourceMap', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteSourceMap', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ContactGroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The IDs of the alert contact groups. The value must be a JSON array.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '[123, 234]'."\n", + ], + [ + 'apiName' => 'GetAppJVMConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAppJVMConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IsAutoStart', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to enable the alert rule after it is created. Default value: `false`.'."\n" - ."\n" - .'* `true`: enables the alert rule.'."\n" - .'* `false`: disables the alert rule.'."\n", - 'type' => 'boolean', - 'required' => false, - 'docRequired' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'UpgradeAddonRelease', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpgradeAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'TemplageAlertConfig', - 'in' => 'query', - 'schema' => [ - 'description' => 'The configurations of the alert template based on which you want to create an alert rule. The value must be a JSON string. You must set at least one of the **TemplateAlertId** and **TemplageAlertConfig** parameters. If you set both parameters, the **TemplateAlertId** parameter prevails. For more information about the TemplageAlertConfig parameter, see the following **additional information about the TemplageAlertConfig parameter**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '[ { "contactGroupIds": "381", "alertType": 5, "alarmContext": { "subTitle": "", "content": "Alarm name: $alarm name\\nFilter condition: $filter\\nAlarm time : $Alarm time\\nAlarm content: $Alarm content\\nNote: Before the recovery email is received, the alarm is in continuous alarm, and you will be reminded again after 24 hours!" }, "alertLevel": "WARN", " metricParam": { "appId": "70901", "pid": "atc889zkcf@d8deedfa9bf****", "type": "TXN", "dimensions": [ { "type": "STATIC", "value ": "\\\\/hello_test_api_address\\\\/test1", "key": "rpc" } ] }, "alertWay": [ "SMS", "MAIL", "DING_ROBOT" ], "alertRule": { "rules" : [ { "measure": "appstat.txn.rt", "alias": "Entry call response time_ms", "aggregates": "AVG", "nValue": 1, "value": 1, "operator ": "CURRENT_GTE" } ], "operator": "|" }, "title": "Alarm template alarm name", "config": "{\\"continuous\\":false,\\"dataRevision\\":2, \\"ownerId\\":\\"123412341234\\"}", "notice": { "noticeStartTime": 1480521600000, "startTime": 1480521600000, "endTime": 1480607940000, "noticeEndTime": 1480607940000 }, "stat us": "NON " } ]', + ], + [ + 'apiName' => 'CreateOrUpdateAlertRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateAlertRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:alertrule/{#AlertRuled}'], ], ], - [ - 'name' => 'AlertId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'example' => '1234567', + ], + [ + 'apiName' => 'DelAuthToken', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DelAuthToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'string', - 'example' => '-', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1234567', - ], - ], + [ + 'apiName' => 'DescribeEnvCustomJob', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvCustomJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"-\\",\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"AlertId\\": 1234567\\n}","type":"json"}]', - 'title' => 'UpdateAlertRule', - ], - 'StartAlert' => [ - 'summary' => '启动报警', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'GetSyntheticTaskMonitors', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'EnableMetric', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:EnableMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:Prometheus/{#ClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SaveTraceAppConfig', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SaveTraceAppConfig', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdatePrometheusMonitoring', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + [ + 'apiName' => 'CheckServiceStatus', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'arms:CheckServiceStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'AlertId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the SearchAlertRules operation and view the `Id` parameter in the response. For more information, see [SearchAlertRules](~~175825~~).', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1610***', + [ + 'apiName' => 'GetClusterAllUrl', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetClusterAllUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-hangzhou`.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'ListPrometheusAlertRules', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListPrometheusAlertRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the call was successful.'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - ], + [ + 'apiName' => 'CheckCommercialStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CheckCommercialStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\"\\n}","errorExample":""},{"type":"xml","example":"<StartAlertResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>27E653FA-5958-45BE-8AA9-14D884DC****</RequestId>\\n</StartAlertResponse>","errorExample":""}]', - 'title' => 'StartAlert', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'StopAlert' => [ - 'summary' => 'Call StartAlert to stop an alert rule.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListEventBridgeIntegrations', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEventBridgeIntegrations', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeEnvPodMonitor', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvPodMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteAlertRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteAlertRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#accountId}:AlertRule/{#AlertRuled}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListScenario', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'arms:ListScenario', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'AlertId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '1610***', + [ + 'apiName' => 'UpdateAlertContactGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateAlertContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'SyncRecordingRules', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SyncRecordingRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'IsSuccess' => [ - 'description' => 'Indicates whether the request is successful. Valid values:'."\n" - ."\n" - .'* `true`: The request is successful.'."\n" - .'* `false`: The request fails.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', - ], - ], + [ + 'apiName' => 'CreateOrUpdateSilencePolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsSuccess\\": true,\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\"\\n}","errorExample":""},{"type":"xml","example":"<StopAlertResponse>\\n\\t<IsSuccess>true</IsSuccess>\\n\\t<RequestId>27E653FA-5958-45BE-8AA9-14D884DC****</RequestId>\\n</StopAlertResponse>","errorExample":""}]', - 'title' => 'StopAlert', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'UpdateDispatchRule' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdatePrometheusGlobalView', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteAddonRelease', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListPrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetRetcodeLogstore', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '44519', - 'abilityTreeNodes' => [ - 'FEATUREarmsVBCGEE', + 'ramAction' => [ + 'action' => 'arms:GetRetcodeLogstore', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'DispatchRule', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dispatch rule configuration. The value is a JSON string. For more information about this parameter, see the following **additional information about the DispatchRule parameter**.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => '{ "id": 123, "system": false, "ruleid": 10282, "name": "Prometheus Alert", "labelMatchExpressionGrid": { "labelMatchExpressionGroups": [ { "labelMatchExpressions": [ { "key": "_aliyun_arms_involvedObject_kind", "value": "app", "operator": "eq" } ] } ] }, "dispatchType": "CREATE_ALERT/DISCARD_ALERT", "isRecover": true, "groupRules": [ { "groupId": 1, "groupingFields": [ "alertname" ], "groupWait": 10, "groupInterval": 15, "repeatInterval": 20 } ], "notifyRules": [ { "notifyObjects": [ { "notifyType": "ARMS_CONTACT", "name": "JohnDoe", "notifyObjectId": 1 }, { "notifyType": "ARMS_CONTACT_GROUP", "name": "JohnDoe_group", "notifyObjectId": 2 } ], "notifyChannels":["dingTalk","wechat","webhook","email"] }, ], }', + [ + 'apiName' => 'UpdateDispatchRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DeleteContactGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Success' => [ - 'description' => 'Indicates whether the request was successful.'."\n" - ."\n" - .'* `true`: The request was successful.'."\n" - .'* `false`: The request failed.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', - ], - ], + [ + 'apiName' => 'Upload', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateSourceMap', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Success\\": true,\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\"\\n}","errorExample":""},{"type":"xml","example":"<UpdateDispatchRuleResponse>\\n <RequestId>A5EC8221-08F2-4C95-9AF1-49FD998C****</RequestId>\\n <Success>true</Success>\\n</UpdateDispatchRuleResponse>","errorExample":""}]', - 'title' => 'UpdateDispatchRule', - 'summary' => 'Modifies a dispatch policy.', - 'requestParamsDescription' => '## Additional information about the **DispatchRule** parameter'."\n" - ."\n" - .'**JSON string example and description**'."\n" - ."\n" - .'```'."\n" - ."\n" - .'{'."\n" - .' "id": 123, // The ID of the dispatch policy. '."\n" - .' "system": false, // Specifies whether the dispatch rule is editable. Valid values: true: not editable. false: editable. '."\n" - .' "ruleid": 10282, // The ID of the dispatch rule. '."\n" - .' "name": "Prometheus Alert", // The name of the dispatch policy. '."\n" - .' "labelMatchExpressionGrid": {'."\n" - .' "labelMatchExpressionGroups": [ // Sets the dispatch rule. '."\n" - .' {'."\n" - .' "labelMatchExpressions": ['."\n" - .' {'."\n" - .' "key": "_aliyun_arms_involvedObject_kind", // The key of the tag of the dispatch rule. For more information, see the next section. '."\n" - .' "value": "app", // The value of the tag. '."\n" - .' "operator": "eq" // The operator used in the dispatch rule. Valid values: eq: equals to. re: matches a regular expression. '."\n" - .' }'."\n" - .' ]'."\n" - .' }'."\n" - .' ]'."\n" - .' },'."\n" - .' "dispatchType": "CREATE_ALERT/DISCARD_ALERT", // The alert handling method. Valid values: CREATE_ALERT: generates an alert. DISCARD_ALERT: discards the alert event and generates no alert.'."\n" - .' "isRecover": true, // Specifies whether to send the restored alert. Valid values: true: sends the alert. false: does not send the alert. '."\n" - .' "groupRules": [ // Sets the event group. '."\n" - .' {'."\n" - .' "groupId": 1, // The ID of the group. '."\n" - .' "groupingFields": [ // The fields that are used to group events. Events with the same field content are assigned to a group. Alerts with the same specified grouping field are sent to the handler in separate notifications. '."\n" - .' "alertname"'."\n" - .' ],'."\n" - .' "groupWait": 10, // The duration for which the system waits after the first alert is sent. After the duration, all alerts are sent in a single notification to the handler. '."\n" - .' "groupInterval": 15, // The grouping interval. During the silence period of repeated alerts, if new alerts are generated, they will be sent after the group waiting time. '."\n" - .' "repeatInterval": 20 // The silence period of repeated alerts. All alerts are repeatedly sent at specified intervals until the alerts are cleared. '."\n" - .' }'."\n" - .' ],'."\n" - .' "notifyRules": [ // Sets the notification rule. '."\n" - .' {'."\n" - .' "notifyObjects": ['."\n" - .' {'."\n" - .' "notifyType": "ARMS_CONTACT", // The type of the alert contact. Valid values: ARMS_CONTACT: contact. ARMS_CONTACT_GROUP: contact group. '."\n" - .' "name": "JohnDoe", // The name of the contact or contact group. '."\n" - .' "notifyObjectId": 1 // The ID of the contact or contact group. '."\n" - .' },'."\n" - .' {'."\n" - .' "notifyType": "ARMS_CONTACT_GROUP",'."\n" - .' "name": "JohnDoe_group",'."\n" - .' "notifyObjectId": 2'."\n" - .' }'."\n" - .' ],'."\n" - .' "notifyChannels":["dingTalk","wechat","webhook","email"] // The notification method. Valid values: dingTalk, sms, webhook, email, and wechat. '."\n" - .' },'."\n" - .' ],'."\n" - .'}'."\n" - .'```'."\n" - ."\n" - .'**Enumerated keys of the tag of the dispatch rule**'."\n" - ."\n" - .'* `_aliyun_arms_userid`: user ID'."\n" - .'* `_aliyun_arms_involvedObject_kind`: type of the associated object'."\n" - .'* `_aliyun_arms_involvedObject_id`: ID of the associated object'."\n" - .'* `_aliyun_arms_involvedObject_name`: name of the associated object'."\n" - .'* `_aliyun_arms_alert_name`: alert name'."\n" - .'* `_aliyun_arms_alert_rule_id`: alert rule ID'."\n" - .'* `_aliyun_arms_alert_type`: alert type'."\n" - .'* `_aliyun_arms_alert_level`: alert severity'."\n", - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchAlertRules' => [ - 'summary' => 'Queries alert rules.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateGrafanaWorkspace', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateGrafanaWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:grafanaworkspace/*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteAlertContactGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteAlertContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'CreateIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UninstallManagedPrometheus', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '44502', - 'abilityTreeNodes' => [ - 'FEATUREarms20UGKV', + 'ramAction' => [ + 'action' => 'arms:UninstallManagedPrometheus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Title', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert rule name.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'AlertRuleTitle', + [ + 'apiName' => 'UpdateIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The alert rule type. Valid values:'."\n" - ."\n" - .'* `1`: custom alert rules that are used to monitor drill-down data sets'."\n" - .'* `3`: custom alert rules that are used to monitor tiled data sets'."\n" - .'* `4`: alert rules that are used to monitor the browser, including the default frontend alert rules'."\n" - .'* `5`: alert rules that are used to monitor applications, including the default application alert rules'."\n" - .'* `6`: the default browser alert rules'."\n" - .'* `7`: the default application alert rules'."\n" - .'* `8`: Tracing Analysis alert rules'."\n" - .'* `101`: Prometheus alert rules'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '4', + ], + [ + 'apiName' => 'GetPrometheusInstance', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number of the page to return. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'ListDispatchRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return per page. Default value: `10`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '20', + ], + [ + 'apiName' => 'DeleteEnvPodMonitor', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteEnvPodMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the alert data. For more information about the mappings between **RegionId** and **SystemRegionId**, see the detailed description below the table.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'SearchTraceAppByName', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:SearchTraceAppByName', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}'], ], ], - [ - 'name' => 'Pid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application that is associated with the alert rule. For more information about how to obtain the PID, see [Obtain the PID of an application](https://help.aliyun.com/document_detail/186100.html?spm=a2c4g.11186623.6.792.1b50654cqcDPyk#title-imy-7gj-qhr).'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + [ + 'apiName' => 'ListEnvironmentFeatures', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentFeatures', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'AppType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application that is associated with the alert rule. Valid values:'."\n" - ."\n" - .'* `TRACE`: application'."\n" - .'* `RETCODE`: browser'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TRACE', + ], + [ + 'apiName' => 'QueryPromInstallStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:QueryPromInstallStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'SystemRegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID of the alert rule. For more information about the mappings between **RegionId** and **SystemRegionId**, see the detailed description below the table.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'RemoveAliClusterIdsFromPrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:RemoveAliClusterIdsFromPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'ResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the resource group. You can obtain the resource group ID in the **Resource Management** console.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'rg-acfmxyexli2****', + ], + [ + 'apiName' => 'ImportAppAlertRules', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateAlertRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:alertrule/{#AlertRuled}'], ], ], - [ - 'name' => 'AlertRuleId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The id of AlertRule.', - 'type' => 'string', - 'required' => false, - 'example' => '12345', + ], + [ + 'apiName' => 'DeleteTraceApp', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteTraceApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}'], ], ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tags.'."\n", - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag. The following system preset fields are provided:'."\n" - ."\n" - .'* traceId: the ID of the trace.'."\n" - .'* serverApp: the name of the server application.'."\n" - .'* clientApp: the name of the client application.'."\n" - .'* service: the name of the operation.'."\n" - .'* rpc: the type of the call.'."\n" - .'* msOfSpan: the duration exceeds a specific value.'."\n" - .'* clientIp: the IP address of the client.'."\n" - .'* serverIp: the IP address of the server.'."\n" - .'* isError: specifies whether the call is abnormal.'."\n" - .'* hasTprof: contains only thread profiling.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The tag value.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, + ], + [ + 'apiName' => 'ListDashboards', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDashboards', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'PageBean' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - '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' => '20', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'AlertRules' => [ - 'description' => 'The details of the alert rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The status of the alert rule. `RUNNING`: The alert rule is enabled. `STOPPED`: The alert rule is disabled.'."\n", - 'type' => 'string', - 'example' => 'RUNNING', - ], - 'UpdateTime' => [ - 'description' => 'The timestamp that shows when the alert rule was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1480521600000', - ], - 'ContactGroupIdList' => [ - 'description' => 'The ID of the contact group. Multiple IDs are separated by commas (,).'."\n", - 'type' => 'string', - 'example' => '381*,572*', - ], - 'CreateTime' => [ - 'description' => 'The timestamp that shows when the alert rule was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1579508519683', - ], - 'AlertTitle' => [ - 'description' => 'The name of the alert rule.'."\n", - 'type' => 'string', - 'example' => 'TestAlertRule', - ], - 'UserId' => [ - 'description' => 'The ID of the user to which the alert rule belongs.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'AlertVersion' => [ - 'description' => 'The version of the alert rule. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '1', - ], - 'HostByAlertManager' => [ - 'description' => 'Indicates whether the alert is sent through the alert center. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'AlertType' => [ - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'* `1`: custom alert rules that are used to monitor drill-down data sets'."\n" - .'* `3`: custom alert rules that are used to monitor tiled data sets'."\n" - .'* `4`: alert rules that are used to monitor the browser, including the default frontend alert rules'."\n" - .'* `5`: alert rules that are used to monitor applications, including the default application alert rules'."\n" - .'* `6`: the default browser alert rules'."\n" - .'* `7`: the default application alert rules'."\n" - .'* `8`: Tracing Analysis alert rules'."\n" - .'* `101`: Prometheus alert rules'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'ContactGroupIds' => [ - 'description' => 'The IDs of the alert contact groups. The value is a JSON array.'."\n", - 'type' => 'string', - 'example' => '[123, 234]', - ], - 'Config' => [ - 'description' => 'The configuration items of the alert rule. The value is a JSON string.'."\n" - ."\n" - .'The configuration item **continuous** indicates whether alert notifications are continuously sent. Valid values:'."\n" - ."\n" - .'* `true`: Alert notifications are sent every minute.'."\n" - .'* `false`: The alert silence feature is enabled.'."\n" - ."\n" - .'The configuration item **dataRevision** indicates the data revision policy that is used if no data is obtained or the data is null. Default value: 2. Valid values:'."\n" - ."\n" - .'* `0`: overwrites the data by using the value 0'."\n" - .'* `1`: overwrites the data by using the value 1'."\n" - .'* `2`: overwrites the data by using the value null. This value indicates that no alert is triggered if no data exists'."\n", - 'type' => 'string', - 'example' => '{\\"continuous\\":true,\\"dataRevision\\":2}', - ], - 'RegionId' => [ - 'description' => 'The ID of the region to which the alert rule belongs.'."\n", - 'type' => 'string', - 'example' => 'cn-hangzhou', - ], - 'AlertLevel' => [ - 'description' => 'The severity of the alerts. Only the value `WARN` is supported.'."\n", - 'type' => 'string', - 'example' => 'WARN', - ], - 'TaskStatus' => [ - 'description' => 'The status of the task. This parameter is hidden from users.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Title' => [ - 'description' => 'The name of the alert.'."\n", - 'type' => 'string', - 'example' => 'AlertTest', - ], - 'TaskId' => [ - 'description' => 'The ID of the Application Real-Time Monitoring Service (ARMS) task that is associated with the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Id' => [ - 'description' => 'The ID of the alert rule.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'AlertWays' => [ - 'description' => 'Sending method of alarm notification.', - 'type' => 'array', - 'items' => [ - 'description' => 'The notification method of the alerts. Valid values:'."\n" - ."\n" - .'* `SMS`: text message'."\n" - .'* `MAIL`: email'."\n" - .'* `DING_ROBOT`: DingTalk chatbot'."\n", - 'type' => 'string', - 'example' => '["MAIL", "SMS", "DING_ROBOT"]', - ], - ], - 'AlarmContext' => [ - 'description' => 'The format of the alert notification.'."\n", - 'type' => 'object', - 'properties' => [ - 'AlarmContentTemplate' => [ - 'description' => 'The template of the alert notification.'."\n", - 'type' => 'string', - 'example' => 'Alert name: $Alert name\\nFilter condition: $Filter\\nAlert time: $Alert time\\nAlert content: $Alert content\\nNote: The alert persists until a reply email is received. The system will remind you again in 24 hours.'."\n", - ], - 'SubTitle' => [ - 'description' => 'The sub-title of the alert notification.'."\n", - 'type' => 'string', - 'example' => 'test', - ], - 'AlarmContentSubTitle' => [ - 'description' => 'The sub-title of the alert notification content.'."\n", - 'type' => 'string', - 'example' => 'TestSubTitle', - ], - 'Content' => [ - 'description' => 'The content of the alert notification.'."\n", - 'type' => 'string', - 'example' => 'Alert name: $Alert name\\nFilter condition: $Filter\\nAlert time: $Alert time\\nAlert content: $Alert content\\nNote: The alert persists until a reply email is received. The system will remind you again in 24 hours.'."\n", - ], - ], - ], - 'AlertRule' => [ - 'description' => 'The conditions of the alert rule. Multiple conditions are separated by the AND or OR logical operators.'."\n", - 'type' => 'object', - 'properties' => [ - 'Operator' => [ - 'description' => 'The logical operator between conditions. Valid values: `&`: AND. `|`: OR.'."\n", - 'type' => 'string', - 'example' => '|', - ], - 'Rules' => [ - 'description' => 'The condition of the alert rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Measure' => [ - 'description' => 'The metric based on which alerts are triggered. For more information, see the "[Alert metrics](https://help.aliyun.com/document_detail/175825.html#h2-url-4)" section in this topic.'."\n", - 'type' => 'string', - 'example' => 'appstat.jvm.SystemDiskFree', - ], - 'Value' => [ - 'description' => 'The threshold of the condition.'."\n", - 'type' => 'number', - 'format' => 'float', - 'example' => '30', - ], - 'Aggregates' => [ - 'description' => 'The aggregation logic of the metric data of the alert rule. Valid values:'."\n" - ."\n" - .'* `AVG`: calculates the average value for each minute'."\n" - .'* `SUM`: calculates the total value for each minute'."\n" - .'* `MAX`: calculates the maximum value for each minute'."\n" - .'* `MIN`: calculates the minimum value for each minute'."\n", - 'type' => 'string', - 'example' => 'AVG', - ], - 'NValue' => [ - 'description' => 'The time range when data is requested. Unit: minutes. For example, a value of 5 indicates that the alert rule applies to the data in the last 5 minutes.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '5', - ], - 'Operator' => [ - 'description' => 'The operation logic of the condition. Valid values:'."\n" - ."\n" - .'* CURRENT_GTE: greater than or equal to'."\n" - .'* CURRENT_LTE: less than or equal to'."\n" - .'* PREVIOUS_UP: the increase percentage compared with the last period'."\n" - .'* PREVIOUS_DOWN: the decrease percentage compared with the last period'."\n" - .'* HOH_UP: the increase percentage compared with the last hour'."\n" - .'* HOH_DOWN: the decrease percentage compared with the last hour'."\n" - .'* DOD_UP: the increase percentage compared with the last day'."\n" - .'* DOD_DOWN: the decrease percentage compared with the last day'."\n", - 'type' => 'string', - 'example' => 'CURRENT_GTE', - ], - 'Alias' => [ - 'description' => 'The displayed description of the alert metric.'."\n", - 'type' => 'string', - 'example' => 'response time_ms'."\n", - ], - ], - ], - ], - ], - ], - 'MetricParam' => [ - 'description' => 'The information about the application that is associated with the alert rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'Type' => [ - 'description' => 'The type of the metric. Valid values:'."\n" - ."\n" - .'* `txn`: the number of API calls during application monitoring'."\n" - .'* `txn_type`: the types of API calls during application monitoring'."\n" - .'* `db`: database metrics'."\n" - .'* `jvm`: Java virtual machine (JVM) metrics'."\n" - .'* `host`: host metrics'."\n" - .'* `exception`: API call errors'."\n", - 'type' => 'string', - 'example' => 'DB', - ], - 'AppGroupId' => [ - 'description' => 'The ID of the application group that is associated with the alert rule. This parameter is applicable to Enterprise Distributed Application Service (EDAS) applications.'."\n", - 'type' => 'string', - 'example' => 'DEFAULT', - ], - 'AppId' => [ - 'description' => 'The auto-increment ID of the ARMS application. You can ignore this ID.'."\n", - 'type' => 'string', - 'example' => '123', - ], - 'Pid' => [ - 'description' => 'The PID of the application that is associated with the alert rule.'."\n", - 'type' => 'string', - 'example' => '9870ca99-8105-4da7-a3a4-d72dd1b1****', - ], - 'Dimensions' => [ - 'description' => 'The dimensions in the condition.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the dimension. Valid values:'."\n" - ."\n" - .'* `rpc`: the name of the API'."\n" - .'* `rpcType`: the type of the API call, such as HTTP or DUBBO'."\n" - .'* `endpoint`: the name of the database'."\n" - .'* `rootIp`: the IP address of the host'."\n", - 'type' => 'string', - 'example' => 'rootIp', - ], - 'Type' => [ - 'description' => 'The type of the dimension. Valid values:'."\n" - ."\n" - .'* `STATIC`: checks only the value of this dimension. In this case, you must set the **dimensions.value** parameter.'."\n" - .'* `ALL`: checks the values of all dimensions. The metrics of all API calls are checked. If an API call triggers an alert, the name of the API is displayed in the alert notification. In this case, you do not need to set the **dimensions.value** parameter.'."\n" - .'* `DISABLE`: aggregates the values of all dimensions. In this case, you do not need to set the **dimensions.value** parameter.'."\n", - 'type' => 'string', - 'example' => 'DISABLE', - ], - 'Value' => [ - 'description' => 'The value of the dimension.'."\n", - 'type' => 'string', - 'example' => '"127.0.0.1"', - ], - ], - ], - ], - ], - ], - 'Notice' => [ - 'description' => 'The time ranges when the alert rule takes effect and when alert notifications are sent.'."\n", - 'type' => 'object', - 'properties' => [ - 'EndTime' => [ - 'description' => 'The end of the time range when the alert rule takes effect within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1480607940000', - ], - 'NoticeEndTime' => [ - 'description' => 'The end of the time range when alert notifications are sent based on the alert rule within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1480607940000', - ], - 'StartTime' => [ - 'description' => 'The beginning of the time range when the alert rule takes effect within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1480521600000', - ], - 'NoticeStartTime' => [ - 'description' => 'The beginning of the time range when alert notifications are sent based on the alert rule within 24 hours per day. This value is a UNIX timestamp. The year, month, and day that are indicated by the timestamp are not displayed in this value. Only the hour, minute, and second are displayed.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1480521600000', - ], - ], - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'GetRumDataForPage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 20,\\n \\"TotalCount\\": 23,\\n \\"AlertRules\\": [\\n {\\n \\"Status\\": \\"RUNNING\\",\\n \\"UpdateTime\\": 1480521600000,\\n \\"ContactGroupIdList\\": \\"381*,572*\\",\\n \\"CreateTime\\": 1579508519683,\\n \\"AlertTitle\\": \\"TestAlertRule\\",\\n \\"UserId\\": \\"113197164949****\\",\\n \\"AlertVersion\\": 1,\\n \\"HostByAlertManager\\": true,\\n \\"AlertType\\": 4,\\n \\"ContactGroupIds\\": \\"[123, 234]\\",\\n \\"Config\\": \\"{\\\\\\\\\\\\\\"continuous\\\\\\\\\\\\\\":true,\\\\\\\\\\\\\\"dataRevision\\\\\\\\\\\\\\":2}\\",\\n \\"RegionId\\": \\"cn-hangzhou\\",\\n \\"AlertLevel\\": \\"WARN\\",\\n \\"TaskStatus\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Title\\": \\"AlertTest\\",\\n \\"TaskId\\": 123,\\n \\"Id\\": 123,\\n \\"AlertWays\\": [\\n \\"[\\\\\\"MAIL\\\\\\", \\\\\\"SMS\\\\\\", \\\\\\"DING_ROBOT\\\\\\"]\\"\\n ],\\n \\"AlarmContext\\": {\\n \\"AlarmContentTemplate\\": \\"报警名称：$报警名称\\\\\\\\n筛选条件：$筛选\\\\\\\\n报警时间：$报警时间\\\\\\\\n报警内容：$报警内容\\\\\\\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\",\\n \\"SubTitle\\": \\"test\\",\\n \\"AlarmContentSubTitle\\": \\"TestSubTitle\\",\\n \\"Content\\": \\"报警名称：$报警名称\\\\\\\\n筛选条件：$筛选\\\\\\\\n报警时间：$报警时间\\\\\\\\n报警内容：$报警内容\\\\\\\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\"\\n },\\n \\"AlertRule\\": {\\n \\"Operator\\": \\"|\\",\\n \\"Rules\\": [\\n {\\n \\"Measure\\": \\"appstat.jvm.SystemDiskFree\\",\\n \\"Value\\": 30,\\n \\"Aggregates\\": \\"AVG\\",\\n \\"NValue\\": 5,\\n \\"Operator\\": \\"CURRENT_GTE\\",\\n \\"Alias\\": \\"调用响应时间_ms\\"\\n }\\n ]\\n },\\n \\"MetricParam\\": {\\n \\"Type\\": \\"DB\\",\\n \\"AppGroupId\\": \\"DEFAULT\\",\\n \\"AppId\\": \\"123\\",\\n \\"Pid\\": \\"9870ca99-8105-4da7-a3a4-d72dd1b1****\\",\\n \\"Dimensions\\": [\\n {\\n \\"Key\\": \\"rootIp\\",\\n \\"Type\\": \\"DISABLE\\",\\n \\"Value\\": \\"\\\\\\"127.0.0.1\\\\\\"\\"\\n }\\n ]\\n },\\n \\"Notice\\": {\\n \\"EndTime\\": 1480607940000,\\n \\"NoticeEndTime\\": 1480607940000,\\n \\"StartTime\\": 1480521600000,\\n \\"NoticeStartTime\\": 1480521600000\\n },\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchAlertRulesResponse>\\n <RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n <PageBean>\\n <PageNumber>1</PageNumber>\\n <PageSize>20</PageSize>\\n <TotalCount>23</TotalCount>\\n <AlertRules>\\n <Status>RUNNING</Status>\\n <UpdateTime>1480521600000</UpdateTime>\\n <ContactGroupIdList>381*,572*</ContactGroupIdList>\\n <CreateTime>1579508519683</CreateTime>\\n <AlertTitle>TestAlertRule</AlertTitle>\\n <UserId>113197164949****</UserId>\\n <AlertVersion>1</AlertVersion>\\n <HostByAlertManager>true</HostByAlertManager>\\n <AlertType>4</AlertType>\\n <ContactGroupIds>[123, 234]</ContactGroupIds>\\n <Config>{\\\\\\"continuous\\\\\\":true,\\\\\\"dataRevision\\\\\\":2}</Config>\\n <RegionId>cn-hangzhou</RegionId>\\n <AlertLevel>WARN</AlertLevel>\\n <TaskStatus>\\"\\"</TaskStatus>\\n <Title>AlertTest</Title>\\n <TaskId>123</TaskId>\\n <Id>123</Id>\\n <AlertWays>[\\"MAIL\\", \\"SMS\\", \\"DING_ROBOT\\"]</AlertWays>\\n <AlarmContext>\\n <AlarmContentTemplate>报警名称：$报警名称\\\\n筛选条件：$筛选\\\\n报警时间：$报警时间\\\\n报警内容：$报警内容\\\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！</AlarmContentTemplate>\\n <SubTitle>test</SubTitle>\\n <AlarmContentSubTitle>TestSubTitle</AlarmContentSubTitle>\\n <Content>报警名称：$报警名称\\\\n筛选条件：$筛选\\\\n报警时间：$报警时间\\\\n报警内容：$报警内容\\\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！</Content>\\n </AlarmContext>\\n <AlertRule>\\n <Operator>|</Operator>\\n <Rules>\\n <Measure>appstat.jvm.SystemDiskFree</Measure>\\n <Value>30</Value>\\n <Aggregates>AVG</Aggregates>\\n <NValue>5</NValue>\\n <Operator>CURRENT_GTE</Operator>\\n <Alias>调用响应时间_ms</Alias>\\n </Rules>\\n </AlertRule>\\n <MetricParam>\\n <Type>DB</Type>\\n <AppGroupId>DEFAULT</AppGroupId>\\n <AppId>123</AppId>\\n <Pid>9870ca99-8105-4da7-a3a4-d72dd1b1****</Pid>\\n <Dimensions>\\n <Key>rootIp</Key>\\n <Type>DISABLED</Type>\\n <Value>\\"127.0.0.1\\"</Value>\\n </Dimensions>\\n </MetricParam>\\n <Notice>\\n <EndTime>1480607940000</EndTime>\\n <NoticeEndTime>1480607940000</NoticeEndTime>\\n <StartTime>1480521600000</StartTime>\\n <NoticeStartTime>1480521600000</NoticeStartTime>\\n </Notice>\\n </AlertRules>\\n </PageBean>\\n</SearchAlertRulesResponse>","errorExample":""}]', - 'title' => 'SearchAlertRules', - 'description' => 'The current operation is no longer maintained. You can call the GetAlertRules operation of Alert Management (New) to query existing alert rules.'."\n", - 'requestParamsDescription' => '### Mappings between **RegionId** and **SystemRegionId**'."\n" - ."\n" - .'The SearchAlertRules operation obtains the alert rules of the specified region based on the value specified for **SystemRegionId**.'."\n" - ."\n" - .'* If the **SystemRegionId** parameter is not specified, the backend automatically uses the **RegionId** value as the **SystemRegionId** value.'."\n" - .'* If the **SystemRegionId** parameter is specified, **RegionId** must be specified based on the following mappings. Otherwise, data cannot be returned.'."\n" - ."\n" - .'|RegionId|SystemRegionId|'."\n" - .'|---|---|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-hangzhou: China (Hangzhou)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-shanghai: China (Shanghai)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-qingdao: China (Qingdao)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-beijing: China (Beijing)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-zhangjiakou: China (Zhangjiakou)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-huhehaote: China (Hohhot)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-shenzhen: China (Shenzhen)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-chengdu: China (Chengdu)|'."\n" - .'|cn-hangzhou: China (Hangzhou)|cn-hongkong: China (Hong Kong)|'."\n" - .'|ap-southeast-1: Singapore|ap-southeast-1: Singapore|'."\n" - .'|ap-southeast-1: Singapore|ap-southeast-2: Australia (Sydney)|'."\n" - .'|ap-southeast-1: Singapore|ap-southeast-3: Malaysia (Kuala Lumpur)|'."\n" - .'|ap-southeast-1: Singapore|ap-southeast-5: Indonesia (Jakarta)|'."\n" - .'|ap-southeast-1: Singapore|ap-south-1: India (Mumbai)|'."\n" - .'|ap-southeast-1: Singapore|me-east-1: UAE (Dubai)|'."\n" - .'|ap-southeast-1: Singapore|ap-southeast-6: Philippines (Manila)|'."\n" - .'|ap-northeast-1: Japan (Tokyo)|ap-northeast-1: Japan (Tokyo)|'."\n" - .'|us-west-1: US (Silicon Valley)|us-west-1: US (Silicon Valley)|'."\n" - .'|us-west-1: US (Silicon Valley)|us-east-1: US (Virginia)|'."\n" - .'|eu-west-1: UK (London)|eu-central-1: Germany (Frankfurt)|'."\n" - .'|eu-west-1: UK (London)|eu-west-1: UK (London)|'."\n" - .'|cn-hangzhou-finance: China East 1 Finance|cn-shanghai-finance-1: China East 2 Finance|'."\n" - .'|cn-hangzhou-finance: China East 1 Finance|cn-hangzhou-finance: China East 1 Finance|'."\n" - ."\n\n" - .'For example, you can perform the following operations to query the alert data of the China (Shanghai) region:'."\n" - ."\n" - .'* Set **RegionId** to **cn-shanghai** if the **SystemRegionId** parameter is not specified.'."\n" - .'* Set **RegionId** to **cn-hangzhou** and **SystemRegionId** to **cn-shanghai**.'."\n" - ."\n" - .'To query the alert rules of the Germany (Frankfurt) region, set **RegionId** to **eu-west-1** and **SystemRegionId** to **eu-central-1**.', - 'responseParamsDescription' => '## Alert metrics'."\n" - ."\n" - .'* Alert type (metricParam.type): txn'."\n" - ."\n" - .' * Dimension (dimensions.key): rpc'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.txn.rt: the response time of API calls (Unit: milliseconds)'."\n" - .' * appstat.txn.count: the number of API calls'."\n" - .' * appstat.txn.errcount: the number of API call errors'."\n" - ."\n" - .'* Alert type (metricParam.type): txn_type'."\n" - ."\n" - .' * Dimension (dimensions.key): rpcType'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.inbound.rt: the response time of API calls for services that are provided by the application (Unit: milliseconds)'."\n" - .' * appstat.inbound.count: the number of API calls for services that are provided by the application'."\n" - .' * appstat.inbound.error: the number of API call errors for services that are provided by the application'."\n" - .' * appstat.outbound.rt: the response time of API calls for services on which the application depends (Unit: milliseconds)'."\n" - .' * appstat.outbound.count: the number of API calls for services on which the application depends'."\n" - .' * appstat.outbound.error: the number of API call errors for services on which the application depends'."\n" - ."\n" - .'* Alert type (metricParam.type): db'."\n" - ."\n" - .' * Dimension (dimensions.key): endpoint'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.database.rt: the response time of API calls for the database'."\n" - .' * appstat.database.count: the number of API calls for the database'."\n" - .' * appstat.database.errcount: the number of API call errors for the database'."\n" - ."\n" - .'* Alert type (metricParam.type): jvm'."\n" - ."\n" - .' * Dimension (dimensions.key): rootIp'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.jvm.heap_used: the total memory space in the JVM heap (Unit: bytes)'."\n" - .' * appstat.jvm.GcPsScavengeCount: the number of garbage collections (GCs) in JVM'."\n" - .' * appstat.jvm.GcPsMarkSweepCount: the number of tag deletions in JVM'."\n" - .' * appstat.jvm.GcG1OldGenCount: the number of Garbage-First (G1) GCs in the old generation'."\n" - .' * appstat.jvm.GcG1YoungGenCount: the number of G1 GCs in the young generation'."\n" - .' * appstat.jvm.gc.YoungGcCountInstant: the number of GCs in the young generation'."\n" - .' * appstat.jvm.gc.OldGcCountInstant: the number of full heap GCs (Full GCs) in JVM'."\n" - .' * appstat.jvm.gc.YoungGcTimeInstant: the time that is consumed for the GCs in the young generation (Unit: milliseconds)'."\n" - .' * appstat.jvm.gc.OldGcTimeInstant: the time that is consumed for the Full GCs in JVM (Unit: milliseconds)'."\n" - .' * appstat.jvm.ThreadCount: the total number of JVM threads'."\n" - .' * appstat.jvm.non_heap_used: the used space of the non-heap JVM memory (Unit: bytes)'."\n" - .' * appstat.jvm.non_heap_max: the maximum space of the non-heap JVM memory (Unit: bytes)'."\n" - .' * appstat.jvm.non_heap_init: the initial space of the non-heap JVM memory (Unit: bytes)'."\n" - .' * appstat.jvm.non_heap_committed: the submitted space of the non-heap JVM memory (Unit: bytes)'."\n" - ."\n" - .'* Alert type (metricParam.type): host'."\n" - ."\n" - .' * Dimension (dimensions.key): rootIp'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.jvm.SystemCpuUser: the CPU usage of the host (Unit: percentage)'."\n" - .' * appstat.jvm.SystemMemFree: the idle memory space of the host (Unit: bytes)'."\n" - .' * appstat.jvm.SystemDiskFree: the idle disk space of the host (Unit: bytes)'."\n" - .' * appstat.jvm.SystemNetInErrs: the number of error messages that are received by the host'."\n" - .' * appstat.jvm.SystemNetOutErrs: the number of error messages that are sent by the host'."\n" - .' * appstat.jvm.SystemLoad: the system load of the host'."\n" - ."\n" - .'* Alert type (metricParam.type): exception'."\n" - ."\n" - .' * Dimension (dimensions.key): rpc'."\n" - ."\n" - .' * Metrics (alertRule.rules.measure):'."\n" - ."\n" - .' * appstat.exception.rt: the response time of abnormal API calls for the application (Unit: milliseconds)'."\n" - .' * appstat.exception.count: the number of abnormal API calls for the application'."\n", - 'extraInfo' => ' ', - ], - 'SearchAlertContact' => [ - 'summary' => 'Queries alert contacts.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdateAlertRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateAlertRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:alertrule/{#AlertRuled}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpdateWebhook', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateWebhook', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ConfigApp', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ConfigApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteSyntheticTask', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ContactName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'John Doe', + [ + 'apiName' => 'DeleteContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Phone', - 'in' => 'query', - 'schema' => [ - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1381111*****', + ], + [ + 'apiName' => 'ListGrafanaWorkspace', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListGrafanaWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/*'], ], ], - [ - 'name' => 'Email', - 'in' => 'query', - 'schema' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'someone@example.com', + ], + [ + 'apiName' => 'GetCloudClusterAllUrl', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetCloudClusterAllUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'SwitchSyntheticTaskStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => '20', + ], + [ + 'apiName' => 'CreateTimingSyntheticTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateTimingSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Set the value to `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'ListNotificationPolicies', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ContactIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '[12345]', + ], + [ + 'apiName' => 'ListPrometheusInstanceByTagAndResourceGroupId', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListPrometheusInstanceByTagAndResourceGroupId', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'description' => 'The response object.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', - ], - 'PageBean' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - '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', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '23', - ], - 'Contacts' => [ - 'description' => 'The information about the alert contacts.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The timestamp generated when the alert contact was updated.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1580258717000', - ], - 'DingRobot' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', - ], - 'Webhook' => [ - 'description' => 'The information about the webhook.'."\n", - 'type' => 'string', - 'example' => '{\\"body\\":\\"{ \\\\\\"msg_type\\\\\\": \\\\\\"text\\\\\\", \\\\\\"content\\\\\\": { \\\\\\"text\\\\\\": \\\\\\"$content\\\\\\" } }\\",\\"header\\":{\\"Arms-Content-Type\\":\\"json\\"},\\"method\\":\\"post\\",\\"params\\":{},\\"url\\":\\"https://***",\\"userId\\":\\"1131971649***\\"}",', - ], - 'Email' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'someone@example.com', - ], - 'ContactId' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'CreateTime' => [ - 'description' => 'The timestamp generated when the alert contact was created.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1572349025000', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'ContactName' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'John Doe', - ], - 'SystemNoc' => [ - 'description' => 'Indicates whether the alert contact receives system notifications. Valid values:'."\n" - ."\n" - .'* `true`: The alert contact receives system notifications.'."\n" - .'* `false`: The alert contact does not receive system notifications.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Content' => [ - 'description' => 'The contact group to which the contact belongs. If your contacts are added to multiple contact groups, the contact groups are separated by vertical bars (|).'."\n", - 'type' => 'string', - 'example' => 'Default Group | SRE Group'."\n", - ], - 'Phone' => [ - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'example' => '1381111*****', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-acfmxyexli2****', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'ListIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 23,\\n \\"Contacts\\": [\\n {\\n \\"UpdateTime\\": 1580258717000,\\n \\"DingRobot\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f6****\\",\\n \\"Webhook\\": \\"{\\\\\\\\\\\\\\"body\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"{ \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"msg_type\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\", \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"text\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\": \\\\\\\\\\\\\\\\\\\\\\\\\\\\\\"$content\\\\\\\\\\\\\\\\\\\\\\\\\\\\\\" } }\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"header\\\\\\\\\\\\\\":{\\\\\\\\\\\\\\"Arms-Content-Type\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"json\\\\\\\\\\\\\\"},\\\\\\\\\\\\\\"method\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"post\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"params\\\\\\\\\\\\\\":{},\\\\\\\\\\\\\\"url\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"https://***\\\\\\",\\\\\\\\\\\\\\"userId\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"1131971649***\\\\\\\\\\\\\\"}\\\\\\",\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"ContactId\\": 123,\\n \\"CreateTime\\": 1572349025000,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"ContactName\\": \\"John Doe\\",\\n \\"SystemNoc\\": false,\\n \\"Content\\": \\"默认分组|SRE分组\\",\\n \\"Phone\\": \\"1381111*****\\",\\n \\"ResourceGroupId\\": \\"rg-acfmxyexli2****\\"\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchAlertContactResponse>\\n <RequestId>21E85B16-75A6-429A-9F65-8AAC9A54****</RequestId>\\n <PageBean>\\n <PageNumber>1</PageNumber>\\n <PageSize>10</PageSize>\\n <TotalCount>23</TotalCount>\\n <Contacts>\\n <UpdateTime>1580258717000</UpdateTime>\\n <DingRobot>https://oapi.dingtalk.com/robot/send?access_token=91f2f6****</DingRobot>\\n <Webhook>{\\\\\\"body\\\\\\":\\\\\\"{ \\\\\\\\\\\\\\"msg_type\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"text\\\\\\\\\\\\\\", \\\\\\\\\\\\\\"content\\\\\\\\\\\\\\": { \\\\\\\\\\\\\\"text\\\\\\\\\\\\\\": \\\\\\\\\\\\\\"$content\\\\\\\\\\\\\\" } }\\\\\\",\\\\\\"header\\\\\\":{\\\\\\"Arms-Content-Type\\\\\\":\\\\\\"json\\\\\\"},\\\\\\"method\\\\\\":\\\\\\"post\\\\\\",\\\\\\"params\\\\\\":{},\\\\\\"url\\\\\\":\\\\\\"https://***\\",\\\\\\"userId\\\\\\":\\\\\\"1131971649***\\\\\\"}\\",</Webhook>\\n <Email>someone@example.com</Email>\\n <ContactId>123</ContactId>\\n <CreateTime>1572349025000</CreateTime>\\n <UserId>113197164949****</UserId>\\n <ContactName>John Doe</ContactName>\\n <SystemNoc>false</SystemNoc>\\n <Content>默认分组|SRE分组</Content>\\n <Phone>1381111*****</Phone>\\n </Contacts>\\n </PageBean>\\n</SearchAlertContactResponse>","errorExample":""}]', - 'title' => 'SearchAlertContact', - 'description' => 'This operation is no longer maintained. To query alert contacts, call the DescribeContacts operation provided by the new version of Alert Management.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchAlertContactGroup' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListEnvCustomJobs', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListEnvCustomJobs', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'QueryCommercialUsage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:QueryCommercialUsage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateEnvPodMonitor', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateEnvPodMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListSilencePolicies', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ContactGroupName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TestGroup', + [ + 'apiName' => 'DeleteEnvironmentFeature', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteEnvironmentFeature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Default value: `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DescribeEnvironmentFeature', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvironmentFeature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'ContactName', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'John Doe', + ], + [ + 'apiName' => 'ListPrometheusIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ContactId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact. You can call the SearchAlertContact operation to query the contact IDs. For more information, see [SearchAlertContact](~~130703~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '123', + ], + [ + 'apiName' => 'GetAlertRules', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetAlertRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ContactGroupIds', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert contact group. You can query multiple alert contact groups at a time. Separate multiple group IDs with commas (,).'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '746', + ], + [ + 'apiName' => 'CreateWebhook', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateWebhook', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'IsDetail', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to return all alert contacts in the queried alert contact group. By default, not all alert contacts are returned.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'AppendInstancesToPrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AppendInstancesToPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', - ], - 'ContactGroups' => [ - 'description' => 'The information about the alert contact groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the alert contact group was last modified. 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' => '1529668855000', - ], - 'ContactGroupName' => [ - 'description' => 'The name of the alert contact group.'."\n", - 'type' => 'string', - 'example' => 'TestGroup', - ], - 'ContactGroupId' => [ - 'description' => 'The ID of the alert contact group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '746', - ], - 'CreateTime' => [ - 'description' => 'The time when the alert contact group list was created. 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' => '1529668855000', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'Contacts' => [ - 'description' => 'The alert contact list.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'UpdateTime' => [ - 'description' => 'The time when the alert contact group was last modified. 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' => '1580258717000', - ], - 'DingRobot' => [ - 'description' => 'The webhook URL of the DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', - ], - 'Email' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'someone@example.com', - ], - 'ContactId' => [ - 'description' => 'The ID of the alert contact.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'CreateTime' => [ - 'description' => 'The time when the alert contact group list was created. 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' => '1572349025000', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'ContactName' => [ - 'description' => 'The name of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'John Doe', - ], - 'SystemNoc' => [ - 'description' => 'Indicates whether the alert contact receives system notifications. Valid values:'."\n" - ."\n" - .'* true: receives system notifications.'."\n" - .'* false: does not receive system notifications.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'Phone' => [ - 'description' => 'The mobile number of the alert contact.'."\n", - 'type' => 'string', - 'example' => '1381111*****', - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeletePrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeletePrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"4D6C358A-A58B-4F4B-94CE-F5AAF023****\\",\\n \\"ContactGroups\\": [\\n {\\n \\"UpdateTime\\": 1529668855000,\\n \\"ContactGroupName\\": \\"TestGroup\\",\\n \\"ContactGroupId\\": 746,\\n \\"CreateTime\\": 1529668855000,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"Contacts\\": [\\n {\\n \\"UpdateTime\\": 1580258717000,\\n \\"DingRobot\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f6****\\",\\n \\"Email\\": \\"someone@example.com\\",\\n \\"ContactId\\": 123,\\n \\"CreateTime\\": 1572349025000,\\n \\"UserId\\": \\"113197164949****\\",\\n \\"ContactName\\": \\"John Doe\\",\\n \\"SystemNoc\\": false,\\n \\"Phone\\": \\"1381111*****\\"\\n }\\n ]\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<SearchAlertContactGroupResponse>\\n<ContactGroups>\\n <ContactGroupId>746</ContactGroupId>\\n <UpdateTime>1529668855000</UpdateTime>\\n <ContactGroupName>TestGroup</ContactGroupName>\\n <UserId>113197164949****</UserId>\\n <CreateTime>1529668855000</CreateTime>\\n</ContactGroups>\\n<ContactGroups>\\n <Contacts>\\n <Email>someone@example.com</Email>\\n <UserId>113197164949****</UserId>\\n <Phone>1381111*****</Phone>\\n <CreateTime>1572349025000</CreateTime>\\n <UpdateTime>1580258717000</UpdateTime>\\n <ContactId>123</ContactId>\\n <DingRobot>https://oapi.dingtalk.com/robot/send?access_token=91f2f6****</DingRobot>\\n <SystemNoc>false</SystemNoc>\\n <ContactName>John Doe</ContactName>\\n </Contacts>\\n</ContactGroups>\\n<RequestId>4D6C358A-A58B-4F4B-94CE-F5AAF023****</RequestId>\\n</SearchAlertContactGroupResponse>","errorExample":""}]', - 'title' => 'SearchAlertContactGroup', - 'summary' => 'Queries alert contact groups.', - 'description' => 'The operation is no longer maintained. Call the DescribeContactGroups operation in the alert management module to query alert contact groups.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchAlertHistories' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'QueryReleaseMetric', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:QueryReleaseMetric', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListClusterFromGrafana', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListClusterFromGrafana', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribeIMRobots', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListRetcodeApps', + 'description' => '', 'operationType' => 'none', - 'abilityTreeCode' => '44501', - 'abilityTreeNodes' => [ - 'FEATUREarmsEYPVV6', + 'ramAction' => [ + 'action' => 'arms:ListRetcodeApps', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'AlertId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the SearchAlertRules operation and view the `Id` parameter in the response. For more information, see [SearchAlertRules](~~175825~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '123', + [ + 'apiName' => 'DeleteSilencePolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteSilencePolicy', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AlertType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'* `1`: a custom alert rule that is used to monitor drill-down data sets'."\n" - .'* `3`: a custom alert rule that is used to monitor tiled data sets'."\n" - .'* `4`: an alert rule that is used to monitor web pages, including the default alert rule for browser monitoring'."\n" - .'* `5`: an alert rule that is used to monitor applications, including the default alert rule for application monitoring'."\n" - .'* `6`: the default alert rule for browser monitoring'."\n" - .'* `7`: the default alert rule for application monitoring'."\n" - .'* `8`: a Tracing Analysis alert rule'."\n" - .'* `101`: a Prometheus alert rule'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '4', + ], + [ + 'apiName' => 'QueryMetricByPage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:QueryMetricByPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeTraceLicenseKey', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeTraceLicenseKey', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: `10`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', + ], + [ + 'apiName' => 'UpdatePrometheusAlertRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region. Default value: `cn-hangzhou`.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'GetTimingSyntheticTask', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetTimingSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. The value is a UNIX timestamp of the LONG data type. Unit: milliseconds. The default value is 10 minutes before the current time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1595568910000', + ], + [ + 'apiName' => 'UpdatePrometheusIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. The value is a UNIX timestamp of the LONG data type. Unit: milliseconds. The default value is the current time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1579499626000', + ], + [ + 'apiName' => 'GetRecordingRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetRecordingRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', - ], - 'PageBean' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - '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', - ], - 'TotalCount' => [ - 'description' => 'The total number of returned entries.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'AlarmHistories' => [ - 'description' => 'The information about alert records.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'AlarmTime' => [ - 'description' => 'The time when the alert notification was sent.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1595564179000', - ], - 'StrategyId' => [ - 'description' => 'The internal fields.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'AlarmResponseCode' => [ - 'description' => 'The response code returned after the alert notification was sent.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Emails' => [ - 'description' => 'The email address of the alert contact.'."\n", - 'type' => 'string', - 'example' => 'someone@example.com', - ], - 'UserId' => [ - 'description' => 'The ID of the user.'."\n", - 'type' => 'string', - 'example' => '113197164949****', - ], - 'AlarmSources' => [ - 'description' => 'The webhook URL, such as the webhook URL of a DingTalk chatbot.'."\n", - 'type' => 'string', - 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****', - ], - 'AlarmContent' => [ - 'description' => 'The content of the alert notification.'."\n", - 'type' => 'string', - 'example' => '"Alert name: Alert1\\nAlert time: 2020-07-24 12:14:00\\nAlert content: A total of four alerts are triggered: \\*\\*\\*\\*"'."\n", - ], - 'Phones' => [ - 'description' => 'The mobile phone number of the alert contact.'."\n", - 'type' => 'string', - 'example' => '1381111****', - ], - 'AlarmType' => [ - 'description' => 'The type of the alert rule. Default value: 4. Valid values:'."\n" - ."\n" - .'* `1`: a custom alert rule that is used to monitor drill-down data sets'."\n" - .'* `3`: a custom alert rule that is used to monitor tiled data sets'."\n" - .'* `4`: an alert rule that is used to monitor web pages, including the default alert rule for browser monitoring'."\n" - .'* `5`: an alert rule that is used to monitor applications, including the default alert rule for application monitoring'."\n" - .'* `6`: the default alert rule for browser monitoring'."\n" - .'* `7`: the default alert rule for application monitoring'."\n" - .'* `8`: a Tracing Analysis alert rule'."\n" - .'* `101`: a Prometheus alert rule'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'Target' => [ - 'description' => 'The internal fields.'."\n", - 'type' => 'string', - 'example' => '""', - ], - 'Id' => [ - 'description' => 'The ID of the alert notification.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"AlarmHistories\\": [\\n {\\n \\"AlarmTime\\": 1595564179000,\\n \\"StrategyId\\": \\"\\\\\\"\\\\\\"\\",\\n \\"AlarmResponseCode\\": 200,\\n \\"Emails\\": \\"someone@example.com\\",\\n \\"UserId\\": \\"113197164949****\\",\\n \\"AlarmSources\\": \\"https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****\\",\\n \\"AlarmContent\\": \\"\\\\\\"报警名称：Alert1\\\\\\\\n报警时间：2020-07-24 12:14:00\\\\\\\\n报警内容：共有4条记录触发异常：****\\\\\\"\\",\\n \\"Phones\\": \\"1381111****\\",\\n \\"AlarmType\\": 4,\\n \\"Target\\": \\"\\\\\\"\\\\\\"\\",\\n \\"Id\\": 123\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchAlertHistoriesResponse>\\n<PageBean>\\n <TotalCount>2</TotalCount>\\n <PageSize>10</PageSize>\\n <PageNumber>1</PageNumber>\\n <AlarmHistories>\\n <Target>\\"\\"</Target>\\n <Phones>1381111****</Phones>\\n <AlarmTime>1595564179000</AlarmTime>\\n <UserId>113197164949****</UserId>\\n <AlarmResponseCode>200</AlarmResponseCode>\\n <AlarmType>4</AlarmType>\\n <StrategyId>\\"\\"</StrategyId>\\n <AlarmContent>\\"报警名称：Alert1\\\\n报警时间：2020-07-24 12:14:00\\\\n报警内容：共有4条记录触发异常：****\\"</AlarmContent>\\n <Emails>someone@example.com</Emails>\\n <Id>123</Id>\\n <AlarmSources>https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****</AlarmSources>\\n </AlarmHistories>\\n</PageBean>\\n<RequestId>2FC13182-B9AF-4E6B-BE51-72669B7C****</RequestId>\\n</SearchAlertHistoriesResponse>","errorExample":""}]', - 'title' => 'SearchAlertHistories', - 'summary' => 'Queries the alert records of an alert rule.', - 'description' => 'This operation is no longer maintained. To query alert records, call the ListAlerts operation provided by the new version of Alert Management.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'SearchEvents' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdateMetricDrop', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateMetricDrop', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:Prometheus/{#ClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'AddPrometheusInstance', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddPrometheusInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DeleteWebhookContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'ListAddonReleases', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListAddonReleases', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'AlertId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the alert rule. You can call the SearchAlertRules operation and view the `Id` parameter in the response. For more information, see [SearchAlertRules](~~175825~~).'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '123', + [ + 'apiName' => 'CreateOrUpdateContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Pid', - 'in' => 'query', - 'schema' => [ - 'description' => 'The process identifier (PID) of the application that is associated with the alert rule.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + [ + 'apiName' => 'OpenArmsDefaultSLR', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:OpenArmsDefaultSLR', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CurrentPage', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of the page to return. Default value: `1`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'SearchAlertContactGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchAlertContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries to return on each page. Default value: `10`.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '10', + ], + [ + 'apiName' => 'AddTagToFlinkCluster', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:AddTagToFlinkCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'GetAgentDownloadUrl', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAgentDownloadUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AppType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the application that is associated with the alert rule. Valid values:'."\n" - ."\n" - .'* `TRACE`: application monitoring'."\n" - .'* `RETCODE`: frontend monitoring'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'TRACE', + ], + [ + 'apiName' => 'UpdateRumFileStatus', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateRumApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AlertType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the alert rule. Valid values:'."\n" - ."\n" - .'* `1`: custom alert rules to monitor drill-down data sets'."\n" - .'* `3`: custom alert rules to monitor tiled data sets'."\n" - .'* `4`: alert rules to monitor the frontend, including the default frontend alert rules'."\n" - .'* `5`: alert rules to monitor applications, including the default application alert rules'."\n" - .'* `6`: the default frontend alert rules'."\n" - .'* `7`: the default application alert rules'."\n" - .'* `8`: Tracing Analysis alert rules'."\n" - .'* `101`: Prometheus alert rules'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '4', + ], + [ + 'apiName' => 'StopTimingSyntheticTask', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:StopTimingSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}'], ], ], - [ - 'name' => 'IsTrigger', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether the alert event is triggered. If you do not set this parameter, all alert events are queried. Valid values:'."\n" - ."\n" - .'* `1`: The event is triggered.'."\n" - .'* `0`: The event is not triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => false, - 'example' => '1', + ], + [ + 'apiName' => 'DeleteGrafanaResource', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteGrafanaResource', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Specify a UNIX timestamp of the LONG data type, in milliseconds. The default value is 10 minutes before the current time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1595565300000', + ], + [ + 'apiName' => 'ChangeResourceGroup', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:ChangeResourceGroup', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'XTraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:xtraceapp/{#Pid}'], + ], + ], + ], + [ + 'apiName' => 'CreateAlertContactGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateAlertContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Specify a UNIX timestamp of the LONG data type, in milliseconds. The default value is the current time.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => false, - 'docRequired' => false, - 'example' => '1595568970000', + ], + [ + 'apiName' => 'ListPrometheusInstances', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListPrometheusInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'IsTrigger' => [ - 'description' => 'Specifies whether the alert event is triggered. If you do not set this parameter, all alert events are queried. Valid values:'."\n" - ."\n" - .'* `1`: The event is triggered.'."\n" - .'* `0`: The event is not triggered.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '0', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '32940175-181B-4B93-966E-4BB69176****', - ], - 'PageBean' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - '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', - ], - 'TotalCount' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '2', - ], - 'Event' => [ - 'description' => 'The information about the alert events.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'EventTime' => [ - 'description' => 'The timestamp when the event occurred.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1595569020000', - ], - 'EventLevel' => [ - 'description' => 'The severity of the event.'."\n", - 'type' => 'string', - 'example' => '1', - ], - 'AlertRule' => [ - 'description' => 'The condition of the alert rule.'."\n", - 'type' => 'string', - 'example' => '{\\"operator\\":\\"&\\",\\"rules\\":[{\\"aggregates\\":\\"AVG\\",\\"alias\\":\\"JVM_线程总数\\",\\"measure\\":\\"appstat.jvm.ThreadCount\\",\\"nValue\\":1,\\"operator\\":\\"HOH_DOWN\\",\\"value\\":50.0}]}', - ], - 'Message' => [ - 'description' => 'The event content. The parameter value is a JSON string. Each key indicates a dimension and each value indicates the alert content in the dimension.'."\n", - 'type' => 'string', - 'example' => 'unknow紧急报警\\nip：172.27.XX.XX\\n应用名 = test\\nRegion = cn-shenzhen\\n异常信息 = {\\"timestamp\\"：\\"1615447972235\\"}', - ], - 'AlertType' => [ - 'description' => 'The type of the alert rule. This parameter is not returned. Valid values:'."\n" - ."\n" - .'* `1`: custom alert rules to monitor drill-down data sets'."\n" - .'* `3`: custom alert rules to monitor tiled data sets'."\n" - .'* `4`: alert rules to monitor the frontend, including the default frontend alert rules'."\n" - .'* `5`: alert rules to monitor applications, including the default application alert rules'."\n" - .'* `6`: the default frontend alert rules'."\n" - .'* `7`: the default application alert rules'."\n" - .'* `8`: Tracing Analysis alert rules'."\n" - .'* `101`: Prometheus alert rules'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '4', - ], - 'AlertName' => [ - 'description' => 'The name of the alert rule that is associated with the event.'."\n", - 'type' => 'string', - 'example' => 'alertName', - ], - 'Id' => [ - 'description' => 'The ID of the event record.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'AlertId' => [ - 'description' => 'The ID of the alert rule that is associated with the event.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '123', - ], - 'Links' => [ - 'description' => 'The list of event URLs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The region ID of the instance with which the connection is associated.'."\n", - 'type' => 'string', - 'example' => '[ "http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633®ionId=cn-hangzhou&pid=****" ]', - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'DeleteEventBridgeIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteEventBridgeIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"IsTrigger\\": 0,\\n \\"RequestId\\": \\"32940175-181B-4B93-966E-4BB69176****\\",\\n \\"PageBean\\": {\\n \\"PageNumber\\": 1,\\n \\"PageSize\\": 10,\\n \\"TotalCount\\": 2,\\n \\"Event\\": [\\n {\\n \\"EventTime\\": 1595569020000,\\n \\"EventLevel\\": \\"1\\",\\n \\"AlertRule\\": \\"{\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"&\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"rules\\\\\\\\\\\\\\":[{\\\\\\\\\\\\\\"aggregates\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"AVG\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"alias\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"JVM_线程总数\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"measure\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"appstat.jvm.ThreadCount\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"nValue\\\\\\\\\\\\\\":1,\\\\\\\\\\\\\\"operator\\\\\\\\\\\\\\":\\\\\\\\\\\\\\"HOH_DOWN\\\\\\\\\\\\\\",\\\\\\\\\\\\\\"value\\\\\\\\\\\\\\":50.0}]}\\",\\n \\"Message\\": \\"unknow紧急报警\\\\\\\\nip：172.27.XX.XX\\\\\\\\n应用名 = test\\\\\\\\nRegion = cn-shenzhen\\\\\\\\n异常信息 = {\\\\\\\\\\\\\\"timestamp\\\\\\\\\\\\\\"：\\\\\\\\\\\\\\"1615447972235\\\\\\\\\\\\\\"}\\",\\n \\"AlertType\\": 4,\\n \\"AlertName\\": \\"alertName\\",\\n \\"Id\\": 123,\\n \\"AlertId\\": 123,\\n \\"Links\\": [\\n \\"[ \\\\\\"http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633®ionId=cn-hangzhou&pid=****\\\\\\" ]\\"\\n ]\\n }\\n ]\\n }\\n}","errorExample":""},{"type":"xml","example":"<SearchEventsResponse>\\n\\t<PageBean>\\n \\t <TotalCount>2</TotalCount>\\n\\t <PageSize>10</PageSize>\\n\\t <PageNumber>1</PageNumber>\\n\\t <Event>\\n\\t <EventLevel>1</EventLevel>\\n\\t <AlertType>4</AlertType>\\n \\t <AlertId>123</AlertId>\\n\\t <AlertName>alertName</AlertName>\\n\\t <Message>unknow紧急报警\\\\nip：172.27.XX.XX\\\\n应用名 = test\\\\nRegion = cn-shenzhen\\\\n异常信息 = {\\\\\\"timestamp\\\\\\"：\\\\\\"1615447972235\\\\\\"}</Message>\\n\\t <EventTime>1595569020000</EventTime>\\n\\t <Id>123</Id>\\n\\t <AlertRule>{\\\\\\"operator\\\\\\":\\\\\\"&\\\\\\",\\\\\\"rules\\\\\\":[{\\\\\\"aggregates\\\\\\":\\\\\\"AVG\\\\\\",\\\\\\"alias\\\\\\":\\\\\\"JVM_线程总数\\\\\\",\\\\\\"measure\\\\\\":\\\\\\"appstat.jvm.ThreadCount\\\\\\",\\\\\\"nValue\\\\\\":1,\\\\\\"operator\\\\\\":\\\\\\"HOH_DOWN\\\\\\",\\\\\\"value\\\\\\":50.0}]}</AlertRule>\\n\\t <Links>[ \\"http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633&regionId=cn-hangzhou&pid=****\\" ]</Links>\\n\\t </Event>\\n\\t</PageBean>\\n\\t<RequestId>32940175-181B-4B93-966E-4BB69176****</RequestId>\\n\\t<IsTrigger>0</IsTrigger>\\n</SearchEventsResponse>","errorExample":""}]', - 'title' => 'SearchEvents', - 'summary' => 'Queries alert event records.', - 'description' => 'Alert event records are different from alert notification records. Alert events are recorded every minute after an alert rule filters data. Alert events can be classified based on whether they are triggered or not. If a triggered event is not in the silence period, an alert notification is sent.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'DescribeDispatchRule' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'ListEscalationPolicies', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'InstallCmsExporter', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:InstallCmsExporter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'QueryAppTopology', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:QueryTopology', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'none', - 'abilityTreeCode' => '44446', - 'abilityTreeNodes' => [ - 'FEATUREarmsVBCGEE', + [ + 'apiName' => 'ListPrometheusMonitoring', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListPrometheusMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'parameters' => [ - [ - 'name' => 'Id', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the dispatch policy.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => false, - 'example' => '12345', + [ + 'apiName' => 'GetPrometheusMonitoring', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'CreateEnvServiceMonitor', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateEnvServiceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The ID of the request.', - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', - ], - 'DispatchRule' => [ - 'description' => 'The struct returned.'."\n", - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the dispatch policy.', - 'type' => 'string', - 'example' => 'Prometheus Alert', - ], - 'IsRecover' => [ - 'description' => 'Whether to send recovered alerts.'."\n" - .'true: send.'."\n" - .'false: do not send.', - 'type' => 'boolean', - 'example' => 'true', - ], - 'DispatchType' => [ - 'description' => 'Alarm handling method.'."\n" - ."\n" - .'CREATE_ALERT: Generate an alert.'."\n" - ."\n" - .'DISCARD_ALERT: Discard the alarm event, that is, no alarm.', - 'type' => 'string', - 'example' => 'CREATE_ALERT', - ], - 'State' => [ - 'description' => 'Indicates whether the dispatch policy is enabled. Valid values: '."\n" - ."\n" - .'- `true`: enabled'."\n" - .'- `false`: disabled', - 'type' => 'string', - 'example' => 'true', - ], - 'RuleId' => [ - 'description' => 'The ID of the dispatch rule.', - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10282', - ], - 'GroupRules' => [ - 'description' => 'The information about groups.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'RepeatInterval' => [ - 'description' => 'The time interval at which a notification is resent for a long-lasting unresolved alert. Unit: seconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '20', - ], - 'GroupId' => [ - 'description' => 'The ID of the group.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '1', - ], - 'GroupWaitTime' => [ - 'description' => 'The waiting time for grouping.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'GroupInterval' => [ - 'description' => 'The grouping interval.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '15', - ], - 'GroupingFields' => [ - 'description' => 'The grouping fields.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The grouping field.', - 'type' => 'string', - 'example' => '_aliyun_arms_involvedObject_kind', - ], - ], - ], - ], - ], - 'NotifyRules' => [ - 'description' => 'The collection of notification methods.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotifyObjects' => [ - 'description' => 'The collection of alert contacts.', - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'NotifyObjectId' => [ - 'description' => 'The ID of the contact or contact group.', - 'type' => 'string', - 'example' => '1', - ], - 'NotifyType' => [ - 'description' => 'The type of the alert contact. Valid values:'."\n" - ."\n" - .'- `CONTACT`: contact'."\n" - .'- `CONTACT_GROUP`: contact group', - 'type' => 'string', - 'example' => 'CONTACT', - ], - 'Name' => [ - 'description' => 'The name of the contact or contact group.', - 'type' => 'string', - 'example' => 'JohnDoe', - ], - ], - ], - ], - 'NotifyChannels' => [ - 'description' => 'The notification method Array.', - 'type' => 'array', - 'items' => [ - 'description' => 'The notification method. Valid values:'."\n" - ."\n" - .'- `dingTalk`'."\n" - .'- `sms`'."\n" - .'- `webhook`'."\n" - .'- `email`'."\n" - .'- `wechat`', - 'type' => 'string', - 'example' => 'email', - ], - ], - ], - ], - ], - 'LabelMatchExpressionGrid' => [ - 'description' => 'The information about the dispatch rule.'."\n", - 'type' => 'object', - 'properties' => [ - 'LabelMatchExpressionGroups' => [ - 'description' => 'The collection of dispatch rules.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'LabelMatchExpressions' => [ - 'description' => 'The collection of conditions of the dispatch rule.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag of the dispatch rule. Valid values:'."\n" - ."\n" - .'* `_aliyun_arms_userid`: user ID'."\n" - .'* `_aliyun_arms_involvedObject_kind`: type of the associated object'."\n" - .'* `_aliyun_arms_involvedObject_id`: ID of the associated object'."\n" - .'* `_aliyun_arms_involvedObject_name`: name of the associated object'."\n" - .'* `_aliyun_arms_alert_name`: alert name'."\n" - .'* `_aliyun_arms_alert_rule_id`: alert rule ID'."\n" - .'* `_aliyun_arms_alert_type`: alert type'."\n" - .'* `_aliyun_arms_alert_level`: alert severity'."\n", - 'type' => 'string', - 'example' => '_aliyun_arms_involvedObject_kind', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'example' => 'app', - ], - 'Operator' => [ - 'description' => 'The operator used in the dispatch rule. Valid values:'."\n" - ."\n" - .'* `eq`: equals to.'."\n" - .'* `re`: matches a regular expression.'."\n", - 'type' => 'string', - 'example' => 'eq', - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], - ], + [ + 'apiName' => 'RemoveSourcesFromPrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:RemoveSourcesFromPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\",\\n \\"DispatchRule\\": {\\n \\"Name\\": \\"Prometheus Alert\\",\\n \\"IsRecover\\": true,\\n \\"DispatchType\\": \\"CREATE_ALERT\\",\\n \\"State\\": \\"true\\",\\n \\"RuleId\\": 10282,\\n \\"GroupRules\\": [\\n {\\n \\"RepeatInterval\\": 20,\\n \\"GroupId\\": 1,\\n \\"GroupWaitTime\\": 10,\\n \\"GroupInterval\\": 15,\\n \\"GroupingFields\\": [\\n \\"_aliyun_arms_involvedObject_kind\\"\\n ]\\n }\\n ],\\n \\"NotifyRules\\": [\\n {\\n \\"NotifyObjects\\": [\\n {\\n \\"NotifyObjectId\\": \\"1\\",\\n \\"NotifyType\\": \\"CONTACT\\",\\n \\"Name\\": \\"JohnDoe\\"\\n }\\n ],\\n \\"NotifyChannels\\": [\\n \\"email\\"\\n ]\\n }\\n ],\\n \\"LabelMatchExpressionGrid\\": {\\n \\"LabelMatchExpressionGroups\\": [\\n {\\n \\"LabelMatchExpressions\\": [\\n {\\n \\"Key\\": \\"_aliyun_arms_involvedObject_kind\\",\\n \\"Value\\": \\"app\\",\\n \\"Operator\\": \\"eq\\"\\n }\\n ]\\n }\\n ]\\n }\\n }\\n}","errorExample":""},{"type":"xml","example":"<DescribeDispatchRuleResponse>\\n<RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****</RequestId>\\n<DispatchRule>\\n <GroupRules>\\n <GroupInterval>15</GroupInterval>\\n <GroupWaitTime>10</GroupWaitTime>\\n <GroupId>1</GroupId>\\n </GroupRules>\\n <GroupRules>\\n <GroupingFields>_aliyun_arms_involvedObject_kind</GroupingFields>\\n </GroupRules>\\n <State>true</State>\\n <RuleId>10282</RuleId>\\n <LabelMatchExpressionGrid>\\n <LabelMatchExpressionGroups>\\n <LabelMatchExpressions>\\n <Operator>eq</Operator>\\n <Value>app</Value>\\n <Key>_aliyun_arms_involvedObject_kind</Key>\\n </LabelMatchExpressions>\\n </LabelMatchExpressionGroups>\\n </LabelMatchExpressionGrid>\\n <NotifyRules>\\n <NotifyObjects>\\n <NotifyType>CONTACT</NotifyType>\\n <NotifyObjectId>1</NotifyObjectId>\\n <Name>JohnDoe</Name>\\n </NotifyObjects>\\n </NotifyRules>\\n <NotifyRules>\\n <NotifyChannels>email</NotifyChannels>\\n </NotifyRules>\\n <Name>Prometheus Alert</Name>\\n</DispatchRule>\\n</DescribeDispatchRuleResponse>","errorExample":""}]', - 'title' => 'DescribeDispatchRule', - 'summary' => 'Queries the information about a dispatch policy.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'ListDispatchRule' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'OpenXtraceDefaultSLR', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:OpenXtraceDefaultSLR', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DeleteRumApp', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteRumApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetRetcodeAppByPid', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetRetcodeApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#RetcodeAppId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeAddonMetrics', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DescribeAddonMetrics', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'Name', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the notification policy. Fuzzy match is supported.'."\n", - 'type' => 'string', - 'required' => false, - 'docRequired' => false, - 'example' => 'Prod', + [ + 'apiName' => 'GetSyntheticMonitors', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticMonitors', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'DoInsightsAction', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DoInsightsAction', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'System', - 'in' => 'query', - 'schema' => [ - 'description' => '* The type of notification policies to be queried. Valid values: `false` (default): notification policies created in Application Real-Time Monitoring Service (ARMS).'."\n" - .'* `true`: notification policies created in an external system.'."\n" - ."\n" - .'> You cannot use the ARMS console to modify the dispatch rules of a notification policy that is created in an external system.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'true', + ], + [ + 'apiName' => 'InitEnvironment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:InitEnvironment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3**** ', - ], - 'DispatchRules' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Name' => [ - 'description' => 'The name of the notification policy.'."\n", - 'type' => 'string', - 'example' => 'Prod', - ], - 'State' => [ - 'description' => 'Indicates whether the notification policy is enabled. Valid values:'."\n" - ."\n" - .'* `true`'."\n" - .'* `false`'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RuleId' => [ - 'description' => 'The ID of the notification policy.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10282', - ], - ], - 'description' => '', - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'RestartEnvironmentFeature', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:RestartEnvironmentFeature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"34ED024E-9E31-434A-9E4E-D9D15C3****\\\\t\\",\\n \\"DispatchRules\\": [\\n {\\n \\"Name\\": \\"Prod\\",\\n \\"State\\": \\"true\\",\\n \\"RuleId\\": 10282\\n }\\n ]\\n}","errorExample":""},{"type":"xml","example":"<ListDispatchRuleResponse>\\n<RequestId>34ED024E-9E31-434A-9E4E-D9D15C3****\\t</RequestId>\\n<DispatchRules>\\n <State>true</State>\\n <RuleId>10282</RuleId>\\n <Name>Prod</Name>\\n</DispatchRules>\\n</ListDispatchRuleResponse>","errorExample":""}]', - 'title' => 'ListDispatchRule', - 'summary' => 'Queries notification policies.', - 'description' => 'The current API operation is no longer maintained. To query the notification policy information, call the ListNotificationPolicies operation instead.'."\n", - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'OpenArmsServiceSecondVersion' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'GetOnCallSchedulesDetail', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetOnCallSchedulesDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'SearchAlertHistories', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchAlertHistories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListEnvironmentAlertRules', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentAlertRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], ], - [ - 'APP' => [], + ], + [ + 'apiName' => 'DescribeDispatchRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DescribeDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], - [ - 'PrivateKey' => [], + ], + [ + 'apiName' => 'DescribeEnvDropMetricsRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvDropMetricsRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], ], - [ - 'BearerToken' => [], + ], + [ + 'apiName' => 'DeleteEnvServiceMonitor', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteEnvServiceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'AddAliClusterIdsToPrometheusGlobalView', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddAliClusterIdsToPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'DescribeEnvironment', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvironment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'Type', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the service. Valid values:'."\n" - ."\n" - .'* `arms`: ARMS'."\n" - .'* `arms_app`: Application Monitoring'."\n" - .'* `arms_web`: Browser Monitoring'."\n" - .'* `prometheus_monitor`: Managed Service for Prometheus'."\n" - .'* `synthetic_post`: Synthetic Monitoring'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'arms', + ], + [ + 'apiName' => 'AddPrometheusIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddPrometheusIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'OrderId' => [ - 'description' => 'The service ID returned if the service is activated.'."\n", - 'type' => 'string', - 'example' => '20896874992****', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '9ED50893-F3C4-42DF-ABB2-C200BE******', - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateDispatchRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', - 'errorMessage' => '用户可用余额小于0，请充值后再次尝试开通。', + [ + 'apiName' => 'UpdateRumApp', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateRumApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"OrderId\\": \\"20896874992****\\",\\n \\"RequestId\\": \\"9ED50893-F3C4-42DF-ABB2-C200BE******\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenArmsServiceSecondVersionResponse>\\n <OrderId>20896874992****</OrderId>\\n <RequestId>9ED50893-F3C4-42DF-ABB2-C200BE******</RequestId>\\n</OpenArmsServiceSecondVersionResponse>","errorExample":""}]', - 'title' => 'OpenArmsServiceSecondVersion', - 'summary' => 'Activates a specified pay-as-you-go sub-service of Application Real-Time Monitoring Service (ARMS).', - 'description' => 'The **OpenArmsServiceSecondVersion** operation supports the following sub-service editions:'."\n" - ."\n" - .'* Application Monitoring: Basic Edition'."\n" - .'* Browser Monitoring: Basic Edition'."\n" - .'* Synthetic Monitoring: Pro Edition (pay-as-you-go)'."\n" - .'* Prometheus Service: Pro Edition'."\n", - ], - 'OpenXtraceDefaultSLR' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'GetExploreUrl', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetExploreUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'DescribeAddonRelease', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DescribeAddonRelease', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'InstallManagedPrometheus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:InstallManagedPrometheus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteDispatchRule', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.', - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'ListActivatedAlerts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListActivatedAlerts', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - .' '."\n" - .'* `true`'."\n" - .'* `false`', - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The request ID.', - 'type' => 'string', - 'example' => '53CACA70-2CF7-490C-BD06-1A2AE4EB****', - ], - ], - 'description' => '', + [ + 'apiName' => 'DeleteNotificationPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"53CACA70-2CF7-490C-BD06-1A2AE4EB****\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenXtraceDefaultSLRResponse>\\n<RequestId>53CACA70-2CF7-490C-BD06-1A2AE4EB****</RequestId>\\n<Data>true</Data>\\n</OpenXtraceDefaultSLRResponse>","errorExample":""}]', - 'title' => 'OpenXtraceDefaultSLR', - 'summary' => 'Activates the service-linked role AliyunServiceRoleForXtrace for Tracing Analysis.', - 'requestParamsDescription' => ' ', - 'responseParamsDescription' => ' ', - 'extraInfo' => ' ', - ], - 'OpenArmsDefaultSLR' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreatePrometheusAlertRule', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreatePrometheusAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetAppApiByPage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAppApiPageInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListOnCallSchedules', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'StopAlert', + 'description' => '', 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:StopAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the region.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'GetAuthToken', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAuthToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Data' => [ - 'description' => 'Indicates whether the call was successful. Valid values:'."\n" - ."\n" - .'* `true`: The call was successful.'."\n" - .'* `false`: The call failed.'."\n", - 'type' => 'string', - 'example' => 'true', - ], - 'RequestId' => [ - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '53CACA70-2CF7-490C-BD06-1A2AE4EB****', - ], - ], - 'description' => '', + [ + 'apiName' => 'StartAlert', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:StartAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"type":"json","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"53CACA70-2CF7-490C-BD06-1A2AE4EB****\\"\\n}","errorExample":""},{"type":"xml","example":"<OpenArmsDefaultSLRResponse>\\n<RequestId>53CACA70-2CF7-490C-BD06-1A2AE4EB****</RequestId>\\n<Data>true</Data>\\n</OpenArmsDefaultSLRResponse>","errorExample":""}]', - 'title' => 'OpenArmsDefaultSLR', - 'summary' => 'Activates the service-linked role AliyunServiceRoleForARMS for Application Real-Time Monitoring Service (ARMS).', - ], - 'ChangeResourceGroup' => [ - 'summary' => 'Moves a resource to a specific resource group.', - 'methods' => [ - 'post', + [ + 'apiName' => 'GetTraceAppConfig', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetTraceAppConfig', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'UpgradeEnvironmentFeature', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpgradeEnvironmentFeature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'SendTTSVerifyLink', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'update', + [ + 'apiName' => 'CreateOrUpdateIMRobot', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'SearchAlertContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchAlertContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'ggxw4lnjuz@cfd34a78f******', + ], + [ + 'apiName' => 'GetPrometheusIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'NewResourceGroupId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ID of the new resource group. You can view the available resource groups in the Resource Management console.'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'rg-aek2vezare****', + ], + [ + 'apiName' => 'ChangeAlarmSeverity', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:ChangeAlarmSeverity', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The resource type.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'APPLICATION', + ], + [ + 'apiName' => 'DeletePrometheusAlertRule', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeletePrometheusAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'ResourceId' => [ - 'description' => 'The resource ID.'."\n", - 'type' => 'string', - 'example' => 'ggxw4lnjuz@cfd34a78f******', - ], - 'ResourceGroupId' => [ - 'description' => 'The ID of the resource group.'."\n", - 'type' => 'string', - 'example' => 'rg-aek2vezare****', - ], - ], - ], - 'Code' => [ - 'description' => 'The status code or error code.', - 'type' => 'string', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The returned message.', - 'type' => 'string', - 'example' => 'message', - ], - ], + [ + 'apiName' => 'DeleteAppList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteAppList', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'GetRumUploadFiles', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumUploadFiles', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"46355DD8-FC56-40C5-BFC6-269DE4F9****\\",\\n \\"Data\\": {\\n \\"ResourceId\\": \\"ggxw4lnjuz@cfd34a78f******\\",\\n \\"ResourceGroupId\\": \\"rg-aek2vezare****\\"\\n },\\n \\"Code\\": \\"200\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', - 'title' => 'ChangeResourceGroup', - ], - 'TagResources' => [ - 'summary' => 'Adds tags to ARMS resources.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'GetSyntheticTaskDetail', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticTaskDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetPrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UpdateEnvServiceMonitor', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateEnvServiceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'StartTimingSyntheticTask', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:StartTimingSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'uxqcr8bh21', - ], - 'required' => true, - 'maxItems' => 50, - 'minItems' => 1, + [ + 'apiName' => 'GetManagedPrometheusStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetManagedPrometheusStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'Tag', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tags to add to the resource. You can specify a maximum of 20 tags.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'code!=""', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Key1', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Test1', - ], - ], - 'required' => false, - ], - 'required' => true, - 'maxItems' => 21, + ], + [ + 'apiName' => 'CreateEnvCustomJob', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateEnvCustomJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the ARMS resources for which you want to modify tags. Valid values:'."\n" - ."\n" - .'* WEB: Browser Monitoring'."\n" - .'* APPLICATION: Application Monitoring'."\n" - .'* PROMETHEUS: Managed Service for Prometheus'."\n" - .'* SYNTHETICTASK: Synthetic Monitoring'."\n" - .'* ALERTRULE: Application Monitoring alert rule'."\n" - .'* PROMETHEUSALERTRULE: Managed Service for Prometheus alert rule'."\n" - .'* XTRACEAPP: Managed Service for OpenTelemetry'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'PROMETHEUS', + ], + [ + 'apiName' => 'ListEnvServiceMonitors', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListEnvServiceMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request', - 'type' => 'string', - 'example' => '05919CF2-B8A1-588D-B3DB-89B3********', - ], - 'Data' => [ - 'description' => 'The returned message.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], + [ + 'apiName' => 'CreateRumApp', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateRumApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', + [ + 'apiName' => 'UpdatePrometheusInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusInstance', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], - [ - 'errorCode' => 'NoPermissionKeyOperator', - 'errorMessage' => 'user is no permission for operating param tagKey.', + ], + ], + [ + 'apiName' => 'DeleteTimingSyntheticTask', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteTimingSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}'], ], - [ - 'errorCode' => 'ResourceIdAndTagIsNull', - 'errorMessage' => 'resourceId or tag param must have one', + ], + ], + [ + 'apiName' => 'ListSyntheticDetail', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListSyntheticDetail', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'TagISNull', - 'errorMessage' => 'param tag must be not null.', + ], + ], + [ + 'apiName' => 'UpdateTimingSyntheticTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:UpdateTimingSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}'], ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', + ], + ], + [ + 'apiName' => 'UninstallPromCluster', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:UninstallPromCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], - [ - 'errorCode' => 'ResourceIdIsNull', - 'errorMessage' => 'param resourceId must be not null.', + ], + ], + [ + 'apiName' => 'UpdateAlertContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:UpdateAlertContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ResourceTypeIllegal', - 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + ], + [ + 'apiName' => 'SearchTraces', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchTraces', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', + ], + ], + [ + 'apiName' => 'OpenVCluster', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:OpenVCluster', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ScopeDisAgreement', - 'errorMessage' => 'Param scope is different from before.', + ], + ], + [ + 'apiName' => 'ListTraceApps', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListTraceApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ParameterNextTokenIllegal', - 'errorMessage' => 'param nextToken is invalid.', + ], + ], + [ + 'apiName' => 'SearchTracesByPage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchTracesByPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameterTagKey', - 'errorMessage' => 'The specified TagKey is invalid.', + ], + ], + [ + 'apiName' => 'ListAlertEvents', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListAlertEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameterTagValue', - 'errorMessage' => 'The specified TagValue is invalid.', + ], + ], + [ + 'apiName' => 'CloseAlarm', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CloseAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'TagKeyIsIllegal', - 'errorMessage' => 'The specified TagKey is invalid.', + ], + ], + [ + 'apiName' => 'UpdateEnvCustomJob', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateEnvCustomJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], - [ - 'errorCode' => 'TagValueIsIllegal', - 'errorMessage' => 'The specified TagValue is invalid.', + ], + ], + [ + 'apiName' => 'AddPrometheusGlobalViewByAliClusterIds', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddPrometheusGlobalViewByAliClusterIds', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ResourceIDOUT', - 'errorMessage' => 'The specified resourceId number is out of range.', + ], + ], + [ + 'apiName' => 'GetRetcodeShareUrl', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetRetcodeShareUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05919CF2-B8A1-588D-B3DB-89B3********\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'TagResources', - ], - 'UntagResources' => [ - 'summary' => 'Removes tags from ARMS resources.', - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'UpdateEnvDropMetricsRule', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateEnvDropMetricsRule', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'CreatePrometheusMonitoring', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreatePrometheusMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'ListEnvironmentMetricTargets', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentMetricTargets', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'UpdatePrometheusMonitoringStatus', + 'description' => '', 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdatePrometheusMonitoringStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'PrometheusMonitoring', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'TagKey', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The tag keys. You can specify a maximum of 20 tag keys.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The tag key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'Key1', - ], - 'required' => false, - 'maxItems' => 21, + [ + 'apiName' => 'ListCmsInstances', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListCmsInstances', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'ResourceId', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The resource IDs. You can specify a maximum of 50 resource IDs.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The instance ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'c7c13c449eea64fe89870ac658de864b4', - ], - 'required' => true, - 'maxItems' => 51, + ], + [ + 'apiName' => 'UpdateGrafanaWorkspaceVersion', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateGrafanaWorkspaceVersion', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], ], ], - [ - 'name' => 'ResourceType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the ARMS resources for which you want to modify tags. Valid values:'."\n" - ."\n" - .'* WEB: Browser Monitoring'."\n" - .'* APPLICATION: Application Monitoring'."\n" - .'* PROMETHEUS: Managed Service for Prometheus'."\n" - .'* SYNTHETICTASK: Synthetic Monitoring'."\n" - .'* ALERTRULE: Application Monitoring alert rule'."\n" - .'* PROMETHEUSALERTRULE: Managed Service for Prometheus alert rule'."\n" - .'* XTRACEAPP: Managed Service for OpenTelemetry'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [], - 'example' => 'PROMETHEUS', + ], + [ + 'apiName' => 'UpdateGrafanaWorkspace', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateGrafanaWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], ], ], - [ - 'name' => 'All', - 'in' => 'query', - 'schema' => [ - 'description' => 'Specifies whether to delete all tags. This parameter takes effect only when the TagKey.N parameter is not specified. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n" - ."\n" - .'Default value: false.'."\n", - 'type' => 'boolean', - 'required' => false, - 'example' => 'False', + ], + [ + 'apiName' => 'ApplyScenario', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ApplyScenario', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Tags', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The list of tags.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestKey', - ], - 'Value' => [ - 'description' => 'The value of the tag.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TestValue', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 21, + ], + [ + 'apiName' => 'ListInsightsEvents', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAlert', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'Id of the request'."\n", - 'type' => 'string', - 'example' => 'FC183B5E-C9AD-5E9E-937F-*******', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - ], + [ + 'apiName' => 'GetRumOcuStatisticData', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumOcuStatisticData', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'NoPermissionKeyOperator', - 'errorMessage' => 'user is no permission for operating param tagKey.', + [ + 'apiName' => 'AddPrometheusGlobalView', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddPrometheusGlobalView', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'DuplicateTagKey', - 'errorMessage' => 'Param tagKey is duplicate.', + ], + ], + [ + 'apiName' => 'UpdateEnvironment', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UpdateEnvironment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], - [ - 'errorCode' => 'NoPermissionUSER', - 'errorMessage' => 'user no permission', + ], + ], + [ + 'apiName' => 'GetPrometheusApiToken', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetPrometheusApiToken', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ResourceIdAndTagIsNull', - 'errorMessage' => 'resourceId or tag param must have one', + ], + ], + [ + 'apiName' => 'CreateEnvironment', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateEnvironment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/*'], ], - [ - 'errorCode' => 'TagISNull', - 'errorMessage' => 'param tag must be not null.', + ], + ], + [ + 'apiName' => 'DescribeWebhookContacts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ScopeDisAgreement', - 'errorMessage' => 'Param scope is different from before.', + ], + ], + [ + 'apiName' => 'CreatePrometheusInstance', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreatePrometheusInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/*'], ], - [ - 'errorCode' => 'ParameterNextTokenIllegal', - 'errorMessage' => 'param nextToken is invalid.', + ], + ], + [ + 'apiName' => 'BindPrometheusGrafanaInstance', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:BindPrometheusGrafanaInstance', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], - [ - 'errorCode' => 'TagNumOUT', - 'errorMessage' => 'the number of tag is out .', + ], + ], + [ + 'apiName' => 'AddRecordingRule', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddRecordingRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], - [ - 'errorCode' => 'ResourceTypeIllegal', - 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + ], + [ + 'apiName' => 'SearchEvents', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchEvents', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ResourceIdIsNull', - 'errorMessage' => 'param resourceId must be not null.', + ], + ], + [ + 'apiName' => 'CreateSyntheticTask', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticTask', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameterTagKey', - 'errorMessage' => 'The specified TagKey is invalid.', + ], + ], + [ + 'apiName' => 'DeletePrometheusMonitoring', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeletePrometheusMonitoring', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InvalidParameterTagValue', - 'errorMessage' => 'The specified TagValue is invalid.', + ], + ], + [ + 'apiName' => 'DeleteGrafanaWorkspace', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteGrafanaWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], ], - [ - 'errorCode' => 'TagKeyIsIllegal', - 'errorMessage' => 'The specified TagKey is invalid.', + ], + ], + [ + 'apiName' => 'DeletePrometheusIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeletePrometheusIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'TagValueIsIllegal', - 'errorMessage' => 'The specified TagValue is invalid.', + ], + ], + [ + 'apiName' => 'DeleteAlertRules', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteAlertRules', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ResourceIDOUT', - 'errorMessage' => 'The specified resourceId number is out of range.', + ], + ], + [ + 'apiName' => 'CreateOrUpdateContactGroup', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC183B5E-C9AD-5E9E-937F-*******\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', - 'title' => 'UntagResources', - ], - 'GetCommercialStatus' => [ - 'summary' => 'Queries whether the current account has activated the commercial edition of a service.', - 'methods' => [ - 'get', - 'post', + [ + 'apiName' => 'CreateAlertContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateAlertContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'ListAddons', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListAddons', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'DescribePrometheusAlertRule', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribePrometheusAlertRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DescribeContactGroups', + 'description' => '', 'operationType' => 'none', - ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + 'ramAction' => [ + 'action' => 'arms:SearchContactGroup', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'CommodityCode', - 'in' => 'query', - 'schema' => [ - 'description' => 'The product code.'."\n" - ."\n" - .'* arms_app_post'."\n" - .'* arms_web_post'."\n" - .'* arms_promethues_public_cn'."\n" - .'* prometheus_pay_public_cn'."\n" - .'* xtrace'."\n" - .'* arms_serverless_public_cn'."\n" - .'* arms_rumserverless_public_cn'."\n" - .'* prometheus_serverless_public_cn'."\n" - .'* xtrace_serverless_public_cn'."\n", - 'type' => 'string', - 'required' => true, - 'example' => 'arms_app_post', + ], + [ + 'apiName' => 'GetTrace', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '49C82193-E991-5F6A-AF3E-1664D8D05CA3', - ], - 'UserAndCommodityStatus' => [ - 'description' => 'The commercialization status of the service.'."\n", - 'type' => 'object', - 'properties' => [ - 'Status' => [ - 'description' => 'The commercialization status.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* Normal: The service is activated.'."\n" - .'* Abnormal: An exception occurs during activation.'."\n" - .'* Free: The service is not activated.'."\n", - 'type' => 'string', - 'enumValueTitles' => [ - 'Normal' => 'Normal', - 'Abnormal' => 'Abnormal', - 'Free' => '', - ], - 'example' => 'Normal', - ], - 'FreeDays' => [ - 'description' => 'The number of days during which the service is free of charge.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '10', - ], - 'Basic' => [ - 'description' => 'Indicates whether you are using the Basic Edition.'."\n", - 'type' => 'boolean', - 'example' => 'false', - ], - 'ChargeType' => [ - 'description' => 'The billing method.'."\n", - 'type' => 'string', - 'example' => 'usage', - ], - 'Lable' => [ - 'description' => 'The tags.'."\n", - 'type' => 'string', - 'example' => 'NEW', - ], - 'ExtraInfo' => [ - 'description' => 'The additional information.'."\n", - 'type' => 'object', - 'example' => 'info', - ], - 'Enable' => [ - 'description' => 'Indicates whether the service is activated.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], + [ + 'apiName' => 'TagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:TagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], + ], + ], + ], + [ + 'apiName' => 'BlockAlarmNotification', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:BlockAlarmNotification', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"49C82193-E991-5F6A-AF3E-1664D8******\\",\\n \\"UserAndCommodityStatus\\": {\\n \\"Status\\": \\"Normal\\",\\n \\"FreeDays\\": 10,\\n \\"Basic\\": false,\\n \\"ChargeType\\": \\"usage\\",\\n \\"Lable\\": \\"NEW\\",\\n \\"ExtraInfo\\": {\\n \\"test\\": \\"test\\",\\n \\"test2\\": 1\\n },\\n \\"Enable\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetCommercialStatus', - ], - 'CheckCommercialStatus' => [ - 'summary' => 'Checks whether Application Real-Time Monitoring Service (ARMS) is available for commercial use in a region.', - 'methods' => [ - 'get', + [ + 'apiName' => 'DescribeContacts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'SearchRetcodeAppByPage', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:SearchRetcodeAppByPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetRumAppInfo', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRumAppInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'DeleteCmsExporter', + 'description' => '', 'operationType' => 'none', - 'riskType' => 'none', - 'chargeType' => 'free', + 'ramAction' => [ + 'action' => 'arms:DeleteCmsExporter', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID. Default value: cn-hangzhou.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + [ + 'apiName' => 'OpenArmsServiceSecondVersion', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:OpenArmsService', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Service', - 'in' => 'query', - 'schema' => [ - 'description' => 'The ARMS sub-service. Valid values:'."\n" - ."\n" - .'* apm: Application Monitoring'."\n" - .'* rum: RUM'."\n" - .'* prometheus: Managed Service for Prometheus'."\n" - .'* xtrace: Managed Service for OpenTelemetry'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'xtrace' => 'xtrace', - 'prometheus' => 'prometheus', - 'rum' => 'rum', - 'apm' => 'apm', - ], - 'example' => 'apm', + ], + [ + 'apiName' => 'GetTraceApp', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetTraceApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:traceapp/{#Pid}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'title' => 'Schema of Response', - 'description' => 'Schema of Response'."\n", - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The ID of the request.'."\n", - 'type' => 'string', - 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'string', - 'example' => 'True', - ], - ], + [ + 'apiName' => 'ListPrometheusAlertTemplates', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListPrometheusAlertTemplates', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'DeleteScenario', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteScenario', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Data\\": \\"True\\"\\n}","type":"json"}]', - 'title' => 'CheckCommercialStatus', - 'description' => 'You can call this operation to check whether ARMS is available for commercial use in a region.'."\n", - ], - 'QueryCommercialUsage' => [ - 'methods' => [ - 'post', - 'get', + [ + 'apiName' => 'CreateOrUpdateEventBridgeIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateOrUpdateEventBridgeIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'schemes' => [ - 'http', - 'https', + [ + 'apiName' => 'GetIntegrationState', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetIntegrationState', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'UntagResources', + 'description' => '', + 'operationType' => 'update', + 'ramAction' => [ + 'action' => 'arms:UntagResources', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#EnvironmentId}'], + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], + ], + ], + ], + [ + 'apiName' => 'AddGrafana', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddGrafana', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ], ], ], - 'operationType' => 'readAndWrite', - 'deprecated' => false, - 'systemTags' => [ - 'operationType' => 'get', + [ + 'apiName' => 'ListAlerts', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetAlarmHistories', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'parameters' => [ - [ - 'name' => 'IntervalInSec', - 'in' => 'query', - 'schema' => [ - 'description' => 'The time interval between data slices. Unit: seconds. Minimum value: 3600.'."\n" - ."\n" - .'Valid values:'."\n" - ."\n" - .'* 3600: 1 hour'."\n" - .'* 86400: 1 day'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => false, - 'docRequired' => true, - 'maximum' => '2147483647', - 'minimum' => '0', - 'enumValueTitles' => [ - 3600 => '', - 86400 => '', - ], - 'example' => '3600', - 'default' => '2147483647', + [ + 'apiName' => 'AddIntegration', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:AddIntegration', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], ], ], - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The start of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775806', - 'minimum' => '0', - 'example' => '1699200000000', + ], + [ + 'apiName' => 'DeleteEnvironment', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteEnvironment', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'docRequired' => true, - 'maximum' => '9223372036854775806', - 'minimum' => '0', - 'example' => '1699286400000', + ], + [ + 'apiName' => 'ListTimingSyntheticTasks', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListTimingSyntheticTasks', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/*'], ], ], - [ - 'name' => 'OrderBy', - 'in' => 'query', - 'schema' => [ - 'description' => 'The dimension by which data is sorted.'."\n" - ."\n" - .'Valid value:'."\n" - ."\n" - .'* dataType'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n" - ."\n" - .' <!-- -->'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'dataType' => 'dataType', - ], - 'example' => 'dataType', + ], + [ + 'apiName' => 'GetRumApps', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:GetRumApps', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Rum', 'arn' => 'acs:arms:{#regionId}:{#accountId}:rum/*'], ], ], - [ - 'name' => 'Metric', - 'in' => 'query', - 'schema' => [ - 'description' => 'The name of the metric. Valid value: USAGEFEE.STAT.'."\n", - 'type' => 'string', - 'required' => true, - 'docRequired' => true, - 'enumValueTitles' => [ - 'USAGEFEE.STAT' => 'USAGEFEE.STAT', - ], - 'example' => 'USAGEFEE.STAT'."\n", + ], + [ + 'apiName' => 'GetCommercialStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetCommercialStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Order', - 'in' => 'query', - 'schema' => [ - 'description' => 'The order in which data is sorted. Valid value:'."\n" - ."\n" - .'* `ASC`: ascending order'."\n" - .'* `DESC`: descending order'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'ASC', + ], + [ + 'apiName' => 'QueryAppMetadata', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:QueryAppMetadata', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'AdvancedFilters', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The filter conditions.'."\n", - 'type' => 'array', - 'items' => [ - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the filter condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'regionId', - ], - 'Value' => [ - 'description' => 'The value of the filter condition.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', - ], - 'OpType' => [ - 'description' => 'The operator. Valid values: eq and in.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'in' => 'in', - 'eq' => 'eq', - ], - 'example' => 'eq', - ], - ], - 'required' => false, - ], - 'required' => false, - 'maxItems' => 15, + ], + [ + 'apiName' => 'ListEnvironments', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListEnvironments', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/*'], ], ], - [ - 'name' => 'Dimensions', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The dimensions of the metric that you want to query. Valid values:'."\n" - ."\n" - .'* dataType: data type'."\n" - .'* productType: product type'."\n" - .'* instanceId: instance ID'."\n" - .'* instanceName: instance name'."\n" - .'* instanceType: instance type'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The dimension of the metric.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'dataType', - ], - 'required' => false, - 'maxItems' => 15, + ], + [ + 'apiName' => 'DeleteEnvCustomJob', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteEnvCustomJob', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'Measures', - 'in' => 'query', - 'style' => 'repeatList', - 'schema' => [ - 'description' => 'The measures of the metric that you want to query.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The measure of the metric. Valid value: byte_sum.'."\n", - 'type' => 'string', - 'required' => false, - 'enumValueTitles' => [ - 'byte_sum' => 'byte_sum', - ], - 'example' => 'byte_sum', - ], - 'required' => false, - 'maxItems' => 15, + ], + [ + 'apiName' => 'GetSyntheticTaskList', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetSyntheticTaskList', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'QueryType', - 'in' => 'query', - 'schema' => [ - 'title' => '', - 'description' => 'The data type. Valid values:'."\n" - ."\n" - .'* instantQuery: non-time series'."\n" - .'* timeSeriesQuery: time series'."\n", - 'type' => 'string', - 'required' => true, - 'enumValueTitles' => [ - 'timeSeriesQuery' => 'timeSeriesQuery', - 'instantQuery' => 'instantQuery', - ], - 'example' => 'instantQuery', + ], + [ + 'apiName' => 'ClaimAlarm', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:ClaimAlarm', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'Code' => [ - 'description' => 'The response status. Valid values: 2XX: The request is successful. 3XX: A redirection message is returned. 4XX: The request is invalid. 5XX: A server error occurs.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'HttpStatusCode' => [ - 'description' => 'The HTTP status code.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'success', - ], - 'RequestId' => [ - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', - ], - 'Success' => [ - 'description' => 'Indicates whether the request was successful. Valid values:'."\n" - ."\n" - .'* true'."\n" - .'* false'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Complete' => [ - 'description' => 'Indicates whether a multi-region query is complete. Valid values:'."\n" - ."\n" - .'* **true**'."\n" - .'* **false**'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - 'Items' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The queried data.'."\n", - 'type' => 'object', - 'example' => '{'."\n" - .' "date": "1697108400",'."\n" - .' "dataType": "metrics",'."\n" - .' "byte_sum": 9497922'."\n" - .'}', - ], - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'DeleteRumUploadFile', + 'description' => '', + 'operationType' => 'delete', + 'ramAction' => [ + 'action' => 'arms:DeleteRumUploadFile', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'errorCodes' => [ - 400 => [ - [ - 'errorCode' => 'ParameterMetricIllegal', - 'errorMessage' => 'The specified metric is invalid.', + [ + 'apiName' => 'ListEnvPodMonitors', + 'description' => '', + 'operationType' => 'list', + 'ramAction' => [ + 'action' => 'arms:ListEnvPodMonitors', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], - [ - 'errorCode' => 'ParameterMeasuresIllegal', - 'errorMessage' => 'The specified Measures is invalid.', + ], + ], + [ + 'apiName' => 'SetRetcodeShareStatus', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SetRetcodeShareStatus', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#RetcodeAppId}'], ], - [ - 'errorCode' => 'ParameterTimeStampIllegal', - 'errorMessage' => 'The specified timeStamp is invalid.', + ], + ], + [ + 'apiName' => 'InstallEnvironmentFeature', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:InstallEnvironmentFeature', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], - [ - 'errorCode' => 'ParameterOrderIllegal', - 'errorMessage' => 'The specified order is invalid.', + ], + ], + [ + 'apiName' => 'ListDashboardsByName', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListDashboardsByName', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ParameterPageSizeIllegal', - 'errorMessage' => 'The specified PageSize is invalid.', + ], + ], + [ + 'apiName' => 'CreateRetcodeApp', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateRetcodeApp', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ParameterIntervalIllegal', - 'errorMessage' => 'The specified interval is invalid.', + ], + ], + [ + 'apiName' => 'CreateOrUpdateNotificationPolicy', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateDispatchRule', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ParameterMeasuresMissing', - 'errorMessage' => 'You must specify measures.', + ], + ], + [ + 'apiName' => 'DeleteRetcodeApp', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteRetcodeApp', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}'], ], - [ - 'errorCode' => 'ParameterDimensionsIllegal', - 'errorMessage' => 'The specified dimensions is invalid.', + ], + ], + [ + 'apiName' => 'GetSourceMapInfo', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetSourceMapInfo', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'ParameterRegionIdIllegal', - 'errorMessage' => 'The specified RegionId is invalid.', + ], + ], + [ + 'apiName' => 'GetRetcodeDataByQuery', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetRetcodeDataByQuery', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], - [ - 'errorCode' => 'InternalError', - 'errorMessage' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', + ], + ], + [ + 'apiName' => 'ListEnvironmentAddons', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentAddons', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - 403 => [ - [ - 'errorCode' => 'APINotAuthorize', - 'errorMessage' => 'The current user is not authorized to access the interface.', + ], + [ + 'apiName' => 'GetGrafanaWorkspace', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:GetGrafanaWorkspace', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', + [ + 'apiName' => 'CreateRumUploadFileUrl', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateRumUploadFileUrl', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Code\\": 200,\\n \\"HttpStatusCode\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"RequestId\\": \\"99A663CB-8D7B-4B0D-A006-03C8EE38E7BB\\",\\n \\"Success\\": true,\\n \\"Data\\": {\\n \\"Complete\\": true,\\n \\"Items\\": [\\n {\\n \\"date\\": \\"1697108400\\",\\n \\"dataType\\": \\"metrics\\",\\n \\"byte_sum\\": 9497922\\n }\\n ]\\n }\\n}","type":"json"}]', - 'title' => 'QueryCommercialUsage', - 'summary' => 'Queries the amount of data written to Application Monitoring, Managed Service for OpenTelemetry, Managed Service for Prometheus, and Real User Monitoring (RUM).', - ], - 'GetRumOcuStatisticData' => [ - 'summary' => 'Queries the observability capacity unit (OCU) usage data of Real User Monitoring (RUM).', - 'methods' => [ - 'get', + [ + 'apiName' => 'SearchAlertRules', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchAlertRules', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:AlertRule/*'], + ], + ], ], - 'schemes' => [ - 'https', + [ + 'apiName' => 'ListEnvironmentDashboards', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentDashboards', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ], + ], ], - 'security' => [ - [ - 'AK' => [], + [ + 'apiName' => 'GetStack', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], ], ], - 'operationType' => 'read', - 'deprecated' => false, - 'systemTags' => [ + [ + 'apiName' => 'GetRumExceptionStack', + 'description' => '', 'operationType' => 'get', - 'riskType' => 'none', - 'chargeType' => 'free', - ], - 'parameters' => [ - [ - 'name' => 'StartTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The beginning of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1600063200000', + 'ramAction' => [ + 'action' => 'arms:GetRumExceptionStack', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'EndTime', - 'in' => 'query', - 'schema' => [ - 'description' => 'The end of the time range to query. Unit: milliseconds.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'required' => true, - 'example' => '1687849260000', + ], + [ + 'apiName' => 'ListEnvironmentKubeResources', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:ListEnvironmentKubeResources', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'QueryType', - 'in' => 'query', - 'schema' => [ - 'description' => 'The type of the query. To query non-time series data, set the value to INSTANT. To query time series data, set the value to TIME_SERIES.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'TIME_SERIES', + ], + [ + 'apiName' => 'GetMultipleTrace', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:GetMultipleTrace', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Filter', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The filter condition. Three types of filter conditions are provided:'."\n" - ."\n" - .'* Application name: pid (Note that the application name is displayed, but the application ID is actually specified)'."\n" - .'* Application type: siteType'."\n" - .'* Data type: dataType'."\n", - 'type' => 'array', - 'items' => [ - 'description' => '', - 'type' => 'object', - 'properties' => [ - 'Key' => [ - 'description' => 'The key of the filter condition. Three types of filter conditions are provided:'."\n" - ."\n" - .'* Application name: pid (Note that the application name is displayed, but the application ID is actually specified)'."\n" - .'* Application type: siteType'."\n" - .'* Data type: dataType'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'pid', - ], - 'OpType' => [ - 'description' => 'The type of the operator. Valid value: in.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'in', - ], - 'Value' => [ - 'description' => 'The value of the filter condition. The value is a JSON array of strings.'."\n", - 'type' => 'any', - 'required' => false, - 'example' => '["b590xxxxx@2dcbxxxxx9", "b590xxxxx@2dcbxxxxx8"]', - ], - ], - 'required' => false, - ], - 'required' => false, + ], + [ + 'apiName' => 'DeleteAlertContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteAlertContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], - [ - 'name' => 'Group', - 'in' => 'query', - 'style' => 'json', - 'schema' => [ - 'description' => 'The grouping fields. Valid values:'."\n" - ."\n" - .'* siteType: The total number of OCUs is grouped by application type.'."\n" - .'* dataType: The total number of OCUs is grouped by data type.'."\n" - .'* pid: The total number of OCUs is grouped by application ID.'."\n" - .'* appName: The total number of OCUs is grouped by application name.'."\n" - .'* startTime: The total number of OCUs is grouped by start time.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The grouping key.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => '['."\n" - .' "siteType",'."\n" - .' "dataType"'."\n" - .']', - ], - 'required' => false, + ], + [ + 'apiName' => 'SearchTraceAppByPage', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:SearchTraceAppByPage', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/*'], ], ], - [ - 'name' => 'Page', - 'in' => 'query', - 'schema' => [ - 'description' => 'The page number.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '1', + ], + [ + 'apiName' => 'DescribeEnvServiceMonitor', + 'description' => '', + 'operationType' => 'get', + 'ramAction' => [ + 'action' => 'arms:DescribeEnvServiceMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'PageSize', - 'in' => 'query', - 'schema' => [ - 'description' => 'The number of entries per page.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'required' => true, - 'example' => '100', + ], + [ + 'apiName' => 'CreateEnvPodMonitor', + 'description' => '', + 'operationType' => 'create', + 'ramAction' => [ + 'action' => 'arms:CreateEnvPodMonitor', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], - [ - 'name' => 'RegionId', - 'in' => 'query', - 'schema' => [ - 'description' => 'The region ID.'."\n", - 'type' => 'string', - 'required' => false, - 'example' => 'cn-hangzhou', + ], + [ + 'apiName' => 'InstallAddon', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:InstallAddon', + 'authLevel' => 'resource', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], ], ], ], - 'responses' => [ - 200 => [ - 'schema' => [ - 'type' => 'object', - 'properties' => [ - 'RequestId' => [ - 'title' => 'Id of the request', - 'description' => 'The request ID.'."\n", - 'type' => 'string', - 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', - ], - 'Code' => [ - 'description' => 'The HTTP status code. The status code 200 indicates that the request was successful.'."\n", - 'type' => 'integer', - 'format' => 'int64', - 'example' => '200', - ], - 'Message' => [ - 'description' => 'The error message returned if the request failed.'."\n", - 'type' => 'string', - 'example' => 'null', - ], - 'Data' => [ - 'description' => 'The returned struct.'."\n", - 'type' => 'object', - 'properties' => [ - 'Items' => [ - 'description' => 'The queried data.'."\n", - 'type' => 'array', - 'items' => [ - 'description' => 'The details of the queried data, in the JSON Map format.'."\n", - 'type' => 'object', - 'additionalProperties' => [ - 'type' => 'any', - 'description' => 'The queried data.'."\n", - 'example' => '{'."\n" - .' "totalChargedSessionCount": "11008",'."\n" - .' "__time__": 1717948800,'."\n" - .' "appName": "Main console",'."\n" - .' "totalOcu": "55",'."\n" - .' "startTime": "1719244800",'."\n" - .' "pid": "b5xxxxxuqs@1f59cxxxxxxxxxb",'."\n" - .' "totalCount": "11"'."\n" - .'}', - ], - ], - ], - 'Total' => [ - 'description' => 'The total number of entries returned.'."\n", - 'type' => 'integer', - 'format' => 'int32', - 'example' => '100', - ], - 'Page' => [ - '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' => '100', - ], - 'Complete' => [ - 'description' => 'Indicates whether the next page exists.'."\n", - 'type' => 'boolean', - 'example' => 'true', - ], - ], - ], - ], - 'description' => '', + [ + 'apiName' => 'CreateOrUpdateWebhookContact', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:CreateContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], ], ], ], - 'staticInfo' => [ - 'returnType' => 'synchronous', - ], - 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"内部错误，请联系客户人员。\\",\\n \\"Data\\": {\\n \\"Items\\": [\\n {\\n \\"key\\": \\"{\\\\n \\\\\\"totalChargedSessionCount\\\\\\": \\\\\\"11008\\\\\\",\\\\n \\\\\\"__time__\\\\\\": 1717948800,\\\\n \\\\\\"appName\\\\\\": \\\\\\"主控制台\\\\\\",\\\\n \\\\\\"totalOcu\\\\\\": \\\\\\"55\\\\\\",\\\\n \\\\\\"startTime\\\\\\": \\\\\\"1719244800\\\\\\",\\\\n \\\\\\"pid\\\\\\": \\\\\\"b5xxxxxuqs@1f59cxxxxxxxxxb\\\\\\",\\\\n \\\\\\"totalCount\\\\\\": \\\\\\"11\\\\\\"\\\\n}\\"\\n }\\n ],\\n \\"Total\\": 100,\\n \\"Page\\": 1,\\n \\"PageSize\\": 100,\\n \\"Complete\\": true\\n }\\n}","type":"json"}]', - 'title' => 'GetRumOcuStatisticData', - 'description' => 'You can query the usage data for the current day at any time. You can query the usage data for the previous day only after 8:00 today.'."\n", - ], - ], - 'endpoints' => [ - [ - 'regionId' => 'cn-qingdao', - 'endpoint' => 'arms.cn-qingdao.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing', - 'endpoint' => 'arms.cn-beijing.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhangjiakou', - 'endpoint' => 'arms.cn-zhangjiakou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-zhengzhou-jva', - 'endpoint' => 'arms.cn-zhengzhou-jva.aliyuncs.com', - ], - [ - 'regionId' => 'cn-huhehaote', - 'endpoint' => 'arms.cn-huhehaote.aliyuncs.com', - ], - [ - 'regionId' => 'cn-wulanchabu', - 'endpoint' => 'arms.cn-wulanchabu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou', - 'endpoint' => 'arms.cn-hangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai', - 'endpoint' => 'arms.cn-shanghai.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen', - 'endpoint' => 'arms.cn-shenzhen.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan', - 'endpoint' => 'arms.cn-heyuan.aliyuncs.com', - ], - [ - 'regionId' => 'cn-guangzhou', - 'endpoint' => 'arms.cn-guangzhou.aliyuncs.com', - ], - [ - 'regionId' => 'cn-chengdu', - 'endpoint' => 'arms.cn-chengdu.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hongkong', - 'endpoint' => 'arms.cn-hongkong.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-1', - 'endpoint' => 'arms.ap-northeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-northeast-2', - 'endpoint' => 'arms.ap-northeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-1', - 'endpoint' => 'arms.ap-southeast-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-2', - 'endpoint' => 'arms.ap-southeast-2.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-3', - 'endpoint' => 'arms.ap-southeast-3.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-5', - 'endpoint' => 'arms.ap-southeast-5.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-6', - 'endpoint' => 'arms.ap-southeast-6.aliyuncs.com', - ], - [ - 'regionId' => 'us-east-1', - 'endpoint' => 'arms.us-east-1.aliyuncs.com', - ], - [ - 'regionId' => 'us-west-1', - 'endpoint' => 'arms.us-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-west-1', - 'endpoint' => 'arms.eu-west-1.aliyuncs.com', - ], - [ - 'regionId' => 'eu-central-1', - 'endpoint' => 'arms.eu-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-south-1', - 'endpoint' => 'arms.ap-south-1.aliyuncs.com', - ], - [ - 'regionId' => 'me-east-1', - 'endpoint' => 'arms.aliyuncs.com', - ], - [ - 'regionId' => 'cn-hangzhou-finance', - 'endpoint' => 'arms.cn-hangzhou-finance.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shanghai-finance-1', - 'endpoint' => 'arms.cn-shanghai-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-shenzhen-finance-1', - 'endpoint' => 'arms.cn-shenzhen-finance-1.aliyuncs.com', - ], - [ - 'regionId' => 'ap-southeast-7', - 'endpoint' => 'arms.ap-southeast-7.aliyuncs.com', - ], - [ - 'regionId' => 'cn-beijing-finance-1', - 'endpoint' => 'arms.aliyuncs.com', - ], - [ - 'regionId' => 'me-central-1', - 'endpoint' => 'arms.me-central-1.aliyuncs.com', - ], - [ - 'regionId' => 'cn-heyuan-acdr-1', - 'endpoint' => 'arms.cn-heyuan-acdr-1.aliyuncs.com', + [ + 'apiName' => 'DeleteIMRobot', + 'description' => '', + 'operationType' => 'none', + 'ramAction' => [ + 'action' => 'arms:DeleteContact', + 'authLevel' => 'operate', + 'actionConditions' => [], + 'resources' => [ + ['validationType' => 'always', 'product' => 'ARMS', 'resourceType' => 'All Resource', 'arn' => '*'], + ], + ], + ], + ], + 'resourceTypes' => [ + ['validationType' => 'always', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/{#environmentId}'], + ['validationType' => 'always', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:alertrule/{#AlertRuled}'], + ['validationType' => 'always', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ['validationType' => 'always', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:Prometheus/{#ClusterId}'], + ['validationType' => 'always', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/{#Pid}'], + ['validationType' => 'always', 'resourceType' => 'PrometheusMonitoring', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/{#type}/{#monitoringName}/*'], + ['validationType' => 'always', 'resourceType' => 'PrometheusAlertRule', 'arn' => 'acs:arms:{#regionId}:${AccountId}:prometheus/${ClusterId}/prometheusalertrule/*'], + ['validationType' => 'always', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#accountId}:AlertRule/{#AlertRuled}'], + ['validationType' => 'always', 'resourceType' => 'Prometheus', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/*'], + ['validationType' => 'always', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:grafanaworkspace/*'], + ['validationType' => 'always', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/*'], + ['validationType' => 'always', 'resourceType' => 'IntegrationExporter', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ['validationType' => 'always', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/*'], + ['validationType' => 'always', 'resourceType' => 'PrometheusAlertRule', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheusalertrule/{#ClusterId}/{#PrometheusAlertRuleId}'], + ['validationType' => 'always', 'resourceType' => 'SyntheticTask', 'arn' => 'acs:arms:{#regionId}:{#accountId}:synthetictask/{#TaskId}'], + ['validationType' => 'always', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#Pid}'], + ['validationType' => 'always', 'resourceType' => 'GrafanaWorkspace', 'arn' => 'acs:arms:{#regionId}:{#accountId}:grafanaworkspace/{#GrafanaWorkspaceId}'], + ['validationType' => 'always', 'resourceType' => 'XTraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:xtraceapp/{#Pid}'], + ['validationType' => 'always', 'resourceType' => 'PrometheusMonitoring', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/*'], + ['validationType' => 'always', 'resourceType' => 'Rum', 'arn' => 'acs:arms:{#regionId}:{#accountId}:rum/*'], + ['validationType' => 'always', 'resourceType' => 'RetcodeApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:retcodeapp/{#RetcodeAppId}'], + ['validationType' => 'always', 'resourceType' => 'PrometheusAlertRule', 'arn' => 'acs:arms:${Region}:${AccountId}:prometheus/${ClusterId}/prometheusalertrule/*'], + ['validationType' => 'always', 'resourceType' => 'PrometheusAlertRule', 'arn' => 'acs:arms:${Region}:${AccountId}:prometheus/${ClusterId}/prometheusalertrule/${PrometheusAlertRuleId}'], + ['validationType' => 'always', 'resourceType' => 'PrometheusMonitoring', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/{#type}/*'], + ['validationType' => 'always', 'resourceType' => 'PrometheusMonitoring', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#ClusterId}'], + ['validationType' => 'always', 'resourceType' => 'Environment', 'arn' => 'acs:arms:{#regionId}:{#accountId}:environment/*'], + ['validationType' => 'always', 'resourceType' => 'PrometheusMonitoring', 'arn' => 'acs:arms:{#regionId}:{#accountId}:prometheus/{#clusterId}/monitoring/{#type}/{#monitoringName}'], + ['validationType' => 'always', 'resourceType' => 'AlertRule', 'arn' => 'acs:arms:{#regionId}:{#AccountId}:AlertRule/*'], + ['validationType' => 'always', 'resourceType' => 'TraceApp', 'arn' => 'acs:arms:{#regionId}:{#accountId}:traceapp/*'], ], ], ]; |