diff options
Diffstat (limited to 'data/zh_cn/arms/2019-08-08')
| -rw-r--r-- | data/zh_cn/arms/2019-08-08/api-docs.php | 52878 |
1 files changed, 52878 insertions, 0 deletions
diff --git a/data/zh_cn/arms/2019-08-08/api-docs.php b/data/zh_cn/arms/2019-08-08/api-docs.php new file mode 100644 index 0000000..adc2a44 --- /dev/null +++ b/data/zh_cn/arms/2019-08-08/api-docs.php @@ -0,0 +1,52878 @@ +<?php return [ + 'version' => '1.0', + 'info' => [ + 'style' => 'V3', + 'product' => 'ARMS', + 'version' => '2019-08-08', + ], + 'directories' => [ + [ + 'id' => 170580, + 'title' => '监控指标', + 'type' => 'directory', + 'children' => [ + 'QueryMetricByPage', + ], + ], + [ + 'id' => 128346, + 'title' => '应用监控', + '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' => '前端监控', + 'type' => 'directory', + 'children' => [ + 'Upload', + 'DeleteSourceMap', + 'GetSourceMapInfo', + 'CreateRetcodeApp', + 'GetRetcodeShareUrl', + 'DeleteRetcodeApp', + 'SetRetcodeShareStatus', + 'ListRetcodeApps', + 'SearchRetcodeAppByPage', + 'GetRetcodeLogstore', + 'GetRetcodeDataByQuery', + 'GetRetcodeAppByPid', + ], + ], + [ + 'id' => 191976, + 'title' => '用户体验监控', + 'type' => 'directory', + 'children' => [ + 'UpdateRumFileStatus', + 'GetRumUploadFiles', + 'GetRumDataForPage', + 'CreateRumUploadFileUrl', + 'DeleteRumUploadFile', + 'GetRumAppInfo', + 'GetRumApps', + 'CreateRumApp', + 'DeleteRumApp', + 'UpdateRumApp', + 'GetRumExceptionStack', + ], + ], + [ + 'id' => 128367, + 'title' => '可观测监控 Prometheus 版', + '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' => '可观测可视化 Grafana 版', + 'type' => 'directory', + 'children' => [ + 'ListGrafanaWorkspace', + 'GetGrafanaWorkspace', + 'CreateGrafanaWorkspace', + 'UpdateGrafanaWorkspace', + 'UpdateGrafanaWorkspaceVersion', + 'DeleteGrafanaWorkspace', + ], + ], + [ + 'id' => 128330, + 'title' => '业务监控', + 'type' => 'directory', + 'children' => [ + 'ApplyScenario', + 'DeleteScenario', + 'ListScenario', + ], + ], + [ + 'id' => 184789, + 'title' => '云拨测（新版）', + 'type' => 'directory', + 'children' => [ + 'CreateTimingSyntheticTask', + 'UpdateTimingSyntheticTask', + 'StopTimingSyntheticTask', + 'StartTimingSyntheticTask', + 'DeleteTimingSyntheticTask', + 'GetSyntheticMonitors', + 'ListTimingSyntheticTasks', + 'GetTimingSyntheticTask', + 'ListSyntheticDetail', + ], + ], + [ + 'id' => 169864, + 'title' => '云拨测（旧版）', + 'type' => 'directory', + 'children' => [ + 'CreateSyntheticTask', + 'GetSyntheticTaskMonitors', + 'SwitchSyntheticTaskStatus', + 'GetSyntheticTaskList', + 'GetSyntheticTaskDetail', + 'DeleteSyntheticTask', + ], + ], + [ + 'id' => 128391, + 'title' => '告警管理（新版）', + '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报警规则（旧版）', + 'type' => 'directory', + 'children' => [ + 'CreatePrometheusAlertRule', + 'DeletePrometheusAlertRule', + 'UpdatePrometheusAlertRule', + 'DescribePrometheusAlertRule', + 'ListPrometheusAlertRules', + 'ListPrometheusAlertTemplates', + ], + ], + [ + 'id' => 128374, + 'title' => '报警（旧版）', + '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' => '访问控制', + 'type' => 'directory', + 'children' => [ + 'OpenArmsServiceSecondVersion', + 'OpenXtraceDefaultSLR', + 'OpenArmsDefaultSLR', + 'ChangeResourceGroup', + 'TagResources', + 'UntagResources', + ], + ], + [ + 'id' => 187814, + 'title' => '产品计费', + 'type' => 'directory', + 'children' => [ + 'GetCommercialStatus', + 'CheckCommercialStatus', + 'QueryCommercialUsage', + 'GetRumOcuStatisticData', + ], + ], + ], + 'components' => [ + 'schemas' => [ + 'CallChainInfo' => [ + 'title' => 'CallChainInfo', + 'type' => 'object', + 'properties' => [ + 'LogTime' => [ + 'title' => 'logTime', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ResultCode' => [ + 'title' => 'resultCode', + 'type' => 'string', + ], + 'Children' => [ + 'title' => 'children', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/CallChainInfo', + ], + ], + 'RpcId' => [ + 'title' => 'rpcId', + 'type' => 'string', + ], + 'RpcType' => [ + 'title' => 'rpcType', + 'type' => 'integer', + 'format' => 'int64', + ], + 'ServerIp' => [ + 'title' => 'serverIp', + 'type' => 'string', + ], + 'AppName' => [ + 'title' => 'appName', + 'type' => 'string', + ], + 'Rpc' => [ + 'title' => 'rpc', + 'type' => 'string', + ], + 'TraceId' => [ + 'title' => 'traceId', + 'type' => 'string', + ], + 'Span' => [ + 'title' => 'span', + 'type' => 'integer', + 'format' => 'int64', + ], + 'HaveSpan' => [ + 'title' => 'haveSpan', + 'type' => 'boolean', + ], + 'AdditionalInfo' => [ + 'title' => 'additionalInfo', + 'type' => 'string', + ], + 'ParentSpanId' => [ + 'title' => 'parentSpanId', + 'type' => 'string', + ], + 'SpanId' => [ + 'title' => 'spanId', + 'type' => 'string', + ], + 'TagMap' => [ + 'title' => 'tagMap', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + 'LogMap' => [ + 'title' => 'logMap', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + 'Pid' => [ + 'title' => 'pid', + 'type' => 'string', + ], + 'AppType' => [ + 'title' => 'appType', + 'type' => 'string', + ], + 'RegionId' => [ + 'title' => 'regionId', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspace' => [ + 'title' => 'grafana', + 'description' => 'Grafana工作区。', + 'type' => 'object', + 'properties' => [ + 'status' => [ + 'title' => '状态', + 'description' => '状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'StartFailed' => '启动失败', + 'Stop' => '停机', + 'Starting' => '启动中', + 'DeleteFailed' => '释放失败', + 'Running' => '运行中', + 'DeleteSucceed' => '释放成功', + ], + 'example' => 'Starting、Running、Stop、DeleteSucceed', + ], + 'description' => [ + 'title' => '描述', + 'description' => '描述。', + 'type' => 'string', + 'example' => '线上生产环境Grafana', + ], + 'grafanaWorkspaceEdition' => [ + 'title' => '版本', + 'description' => '版本。', + 'type' => 'string', + 'enumValueTitles' => [ + 'standard' => '内测版', + 'personal_edition' => '开发者版', + 'experts_edition' => '专家版', + 'advanced_edition' => '高级版', + ], + 'example' => 'personal_edition、experts_edition、advanced_edition、standard', + ], + 'endTime' => [ + 'title' => '到期时间', + 'description' => '到期时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1652803200000', + ], + 'grafanaWorkspaceId' => [ + 'title' => '工作区Id', + 'description' => '工作区ID。', + 'type' => 'string', + 'example' => 'grafana-cn-4xl3g******', + ], + 'upgradeVersion' => [ + 'title' => '可升级的版本', + 'description' => '可升级的版本列表。', + 'type' => 'array', + 'items' => [ + 'description' => '升级到的版本。', + 'type' => 'string', + 'example' => '9.0.x', + ], + ], + 'grafanaWorkspaceIp' => [ + 'title' => '公网ip带端口', + 'description' => '公网IP和端口。', + 'type' => 'string', + 'example' => '47.110.71.***:443', + ], + 'snatIp' => [ + 'title' => '出口IP', + 'description' => '出口IP。', + 'type' => 'string', + 'example' => '47.110.71.***', + ], + 'grafanaWorkspaceDomain' => [ + 'title' => '工作区域名', + 'description' => '工作区域名。', + 'type' => 'string', + 'example' => 'my-grafana.grafana.aliyuncs.com:443', + ], + 'grafanaWorkspaceDomainStatus' => [ + 'title' => '工作区域名状态', + 'description' => '工作区域名状态', + 'type' => 'string', + 'example' => 'on', + ], + 'commercial' => [ + 'title' => '是否商业化', + 'description' => '是否商业化。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'grafanaWorkspaceName' => [ + 'title' => '工作区名称', + 'description' => '工作区名称。', + 'type' => 'string', + 'example' => '线上生产环境Grafana', + ], + 'grafanaVersion' => [ + 'title' => '对应的Grafana版本', + 'description' => 'Grafana版本号。', + 'type' => 'string', + 'enumValueTitles' => [ + '8.2.x' => '8.2.x', + '10.0.x' => '10.0.x', + '9.0.x' => '9.0.x', + ], + 'example' => '9.0.x', + ], + 'gmtCreate' => [ + 'title' => '1642079398000', + 'description' => '创建时间。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1642079398000', + ], + 'userId' => [ + 'title' => '用户id', + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1412143830******', + ], + 'maxAccount' => [ + 'title' => '最大账号数量', + 'description' => '最大账号数量。', + 'type' => 'string', + 'example' => '10', + ], + 'regionId' => [ + 'title' => '地域ID', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'protocol' => [ + 'title' => '协议', + 'description' => '网络协议类型。', + 'type' => 'string', + 'example' => 'http、https', + ], + 'shareSynced' => [ + 'title' => '是否有过共享版迁移引导', + 'description' => '是否有过共享版迁移引导。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ntmId' => [ + 'title' => '实例id', + 'description' => '南天门ID。', + 'type' => 'string', + 'example' => 'grafana-cn-4xl3g******', + ], + 'personalDomain' => [ + 'title' => '个性化域名', + 'description' => '个性化域名。', + 'type' => 'string', + 'example' => 'my-grafana.grafana.aliyuncs.com:443', + ], + 'personalDomainPrefix' => [ + 'title' => '个性化域名前缀', + 'description' => '个性化域名的前缀。', + 'type' => 'string', + 'example' => 'my-grafana', + ], + 'resourceGroupId' => [ + 'title' => '资源组id', + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2f4vzrfs6cla', + ], + 'deployType' => [ + 'title' => '部署模式', + 'description' => 'Grafana底层部署模式，用户无需关注。', + 'type' => 'string', + 'example' => 'asi', + ], + 'tags' => [ + 'title' => '标签', + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '实例标签。', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '键', + 'description' => '键。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'value' => [ + 'title' => '值', + 'description' => '值。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'privateIp' => [ + 'title' => '私网ip带端口', + 'description' => '私网IP和端口。', + 'type' => 'string', + 'example' => '192.168.1.1'."\n", + ], + 'privateDomain' => [ + 'title' => '私网工作区域名', + 'description' => '私网工作区域名。', + 'type' => 'string', + 'example' => 'my-grafana.grafana.aliyuncs.com:80', + ], + ], + ], + 'GrafanaWorkspaceAccount' => [ + 'title' => '账号', + 'description' => 'Grafana阿里云账号', + 'type' => 'object', + 'properties' => [ + 'accountId' => [ + 'title' => '账号ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'aliyunUid' => [ + 'title' => '阿里云UID', + 'type' => 'string', + 'example' => '131243781293', + ], + 'aliyunUserName' => [ + 'title' => '阿里云账号名', + 'type' => 'string', + 'example' => 'test', + ], + 'accountNotes' => [ + 'title' => '备注', + 'type' => 'string', + ], + 'gmtCreate' => [ + 'title' => '1642079398000', + 'type' => 'number', + 'format' => 'float', + 'example' => '创建时间', + ], + 'orgs' => [ + 'title' => '组织权限', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceUserOrg', + ], + ], + 'type' => [ + 'title' => '类型', + 'type' => 'string', + 'example' => 'aliyun', + ], + ], + ], + 'GrafanaWorkspaceAlertNotification' => [ + 'title' => 'Grafana Notification信息', + 'description' => 'Grafana告警Notification信息', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => 'ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'name' => [ + 'title' => '名称', + 'type' => 'string', + 'example' => 'test', + ], + 'uid' => [ + 'title' => 'Grafana UID', + 'type' => 'string', + 'example' => 'Xfdf******', + ], + 'type' => [ + 'title' => '类型', + 'type' => 'string', + 'example' => 'Email', + ], + 'isDefault' => [ + 'title' => '是否默认', + 'type' => 'boolean', + 'example' => 'true', + ], + 'isArms' => [ + 'title' => '是否ARMS系统类型', + 'type' => 'boolean', + 'example' => 'true', + ], + 'sendReminder' => [ + 'title' => '发送提醒', + 'type' => 'boolean', + 'example' => 'true', + ], + 'settings' => [ + 'title' => '其他配置', + 'type' => 'string', + 'example' => '{}', + ], + ], + ], + 'GrafanaWorkspaceArmsAlertConfig' => [ + 'title' => 'Grafana ARMS 告警配置', + 'description' => 'Grafana ARMS告警信息配置', + 'type' => 'object', + 'properties' => [ + 'armsAlertsEnable' => [ + 'title' => '是否启用', + 'type' => 'string', + 'example' => 'true', + ], + 'armsAlertsWebhookUrl' => [ + 'title' => '告警Webhook地址', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceCustomDomain' => [ + 'title' => 'Grafana工作区自定义域名配置', + 'description' => 'Grafana自定义域名', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'date' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1688627798017', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-***********', + ], + 'status' => [ + 'title' => '状态', + 'type' => 'string', + 'example' => 'CreateSucceed', + 'enum' => [ + 'Creating', + 'CreateFailed', + 'CreateSucceed', + 'Deleting', + 'DeleteFailed', + 'DeleteSucceed', + ], + ], + 'domain' => [ + 'title' => '域名', + 'type' => 'string', + 'example' => 'mydomain.com', + ], + 'uri' => [ + 'title' => '路由配置', + 'type' => 'string', + 'example' => '/', + ], + 'protocol' => [ + 'title' => '网络协议', + 'type' => 'string', + 'example' => 'https', + ], + 'cert' => [ + 'title' => 'PEM 证书内容', + 'type' => 'string', + 'example' => 'protocol为http时无需填写;', + ], + 'key' => [ + 'title' => 'PEM 证书密钥', + 'type' => 'string', + 'example' => 'protocol为http时无需填写;', + ], + 'privateZone' => [ + 'title' => '是否私网域名', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + 'GrafanaWorkspaceDashboardReport' => [ + 'title' => 'Grafana Dashboard数据报表', + 'description' => 'Grafana Dashboard数据报表', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'lastSendTime' => [ + 'title' => '最近发送时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'name' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'url' => [ + 'title' => '配置链接地址', + 'type' => 'string', + 'example' => 'Dashboard URL', + ], + 'status' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + 'reportChannelType' => [ + 'title' => '通知渠道类型', + 'type' => 'string', + 'example' => 'Email', + ], + 'reportChannelTarget' => [ + 'title' => '通知目标', + 'type' => 'string', + 'example' => '******@aliyun.com', + ], + 'reportType' => [ + 'title' => '导出类型', + 'type' => 'string', + 'example' => 'Image', + ], + 'reportStyle' => [ + 'title' => '布局类型', + 'type' => 'string', + 'example' => 'Grid,Simple', + ], + 'triggerType' => [ + 'title' => '发送时间类型', + 'type' => 'string', + 'example' => 'ByWeek', + ], + 'triggerDay' => [ + 'title' => '发送时间 天', + 'type' => 'string', + 'example' => '1', + ], + 'triggerTime' => [ + 'title' => '发送时间 时分', + 'type' => 'string', + 'example' => '12:25', + ], + ], + ], + 'GrafanaWorkspaceDashboardSync' => [ + 'title' => 'Grafana共享版导入对象参数', + 'description' => 'Grafana共享版导入参数', + 'type' => 'object', + 'properties' => [ + 'type' => [ + 'title' => 'type', + 'type' => 'string', + 'example' => 'normal', + ], + 'folderId' => [ + 'title' => 'folderId', + 'type' => 'string', + 'example' => '123456', + ], + 'folderUid' => [ + 'title' => 'folderUid', + 'type' => 'string', + 'example' => 'vxeupqn', + ], + 'folderTitle' => [ + 'title' => 'folderTitle', + 'type' => 'string', + 'example' => 'test', + ], + 'folderURL' => [ + 'title' => 'folderURL', + 'type' => 'string', + 'example' => 'https://g.console.aliyun.com/d/1098370038733503-14960236-422-3/ack-pro-apiserver', + ], + 'dashboardUid' => [ + 'title' => 'dashboardUid', + 'type' => 'string', + 'example' => 'xxxdvxsea', + ], + 'dashboardTitle' => [ + 'title' => 'dashboardTitle', + 'type' => 'string', + 'example' => 'testTitle', + ], + 'dashboardURL' => [ + 'title' => 'dashboardURL', + 'type' => 'string', + 'example' => 'https://g.console.aliyun.com/d/1098370038733503-14960236-422-3/ack-pro-apiserver', + ], + 'orgId' => [ + 'title' => 'orgId', + 'type' => 'string', + 'example' => '1', + ], + 'orgName' => [ + 'title' => 'orgName', + 'type' => 'string', + 'example' => 'user123', + ], + ], + ], + 'GrafanaWorkspaceDataBackup' => [ + 'title' => 'Grafana数据备份配置', + 'description' => 'Grafana数据备份配置', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'gmtModified' => [ + 'title' => '配置更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'processName' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'subType' => [ + 'title' => '配置类型', + 'type' => 'string', + 'example' => 'User', + 'enum' => [ + 'System', + 'User', + 'Restore', + ], + ], + 'processStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceIniBackup' => [ + 'title' => 'Grafana配置参数备份配置', + 'description' => 'Grafana参数备份配置', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'gmtModified' => [ + 'title' => '配置更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'processName' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'subType' => [ + 'title' => '配置类型', + 'type' => 'string', + 'example' => 'User', + 'enum' => [ + 'System', + 'User', + 'Restore', + ], + ], + 'processStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + 'ext' => [ + 'title' => '扩展信息', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceIniProperty' => [ + 'title' => 'GrafanaIni配置参数属性', + 'description' => 'Grafana工作区参数属性', + 'type' => 'object', + 'properties' => [ + 'key' => [ + 'title' => '参数名称', + 'type' => 'string', + ], + 'value' => [ + 'title' => '参数值', + 'type' => 'string', + ], + 'defaultValue' => [ + 'title' => '参数默认值', + 'type' => 'string', + ], + 'description' => [ + 'title' => '参数描述', + 'type' => 'string', + ], + 'example' => [ + 'title' => '参数值示例', + 'type' => 'string', + ], + 'secret' => [ + 'title' => '是否加密字段', + 'type' => 'boolean', + ], + ], + ], + 'GrafanaWorkspaceIniSection' => [ + 'title' => 'GrafanaIni参数对象', + 'description' => 'Grafana工作区参数对象', + 'type' => 'object', + 'properties' => [ + 'section' => [ + 'title' => '参数区块名称', + 'type' => 'string', + ], + 'propertys' => [ + 'title' => '参数属性列表', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceIniProperty', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegration' => [ + 'title' => '集成信息', + 'description' => 'Grafana集成项', + 'type' => 'object', + 'properties' => [ + 'integrationName' => [ + 'title' => '集成名称', + 'type' => 'string', + ], + 'integrationId' => [ + 'title' => '集成配置Id', + 'type' => 'string', + ], + 'status' => [ + 'title' => '集成状态', + 'type' => 'string', + ], + 'datasourceAmount' => [ + 'title' => '已集成的数据源数量', + 'type' => 'integer', + 'format' => 'int64', + ], + 'supportRegions' => [ + 'title' => '支持的region列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + ], + ], + 'previews' => [ + 'title' => '预览信息', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceIntegrationPreview', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegrationDataSource' => [ + 'title' => '集成的数据源信息', + 'description' => 'Grafana集成的数据源', + 'type' => 'object', + 'properties' => [ + 'datasourceId' => [ + 'title' => '数据源id', + 'type' => 'string', + ], + 'datasourceName' => [ + 'title' => '数据源名称', + 'type' => 'string', + ], + 'clusterType' => [ + 'title' => '集群类型', + 'type' => 'string', + ], + 'regionId' => [ + 'title' => 'regionId', + 'type' => 'string', + ], + 'type' => [ + 'title' => '数据源类型', + 'type' => 'string', + ], + 'status' => [ + 'title' => '集成状态', + 'type' => 'string', + ], + 'datasourceUrl' => [ + 'title' => '数据源地址', + 'type' => 'string', + ], + 'folderUrl' => [ + 'title' => 'Grafana文件夹地址', + 'type' => 'string', + ], + 'exploreUrl' => [ + 'title' => 'Grafana浏览地址', + 'type' => 'string', + ], + 'description' => [ + 'title' => '数据源描述', + 'type' => 'string', + ], + 'extra' => [ + 'title' => '数据源备注信息', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegrationDetail' => [ + 'title' => '具体集成项信息', + 'description' => 'Grafana集成明细', + 'type' => 'object', + 'properties' => [ + 'integrationId' => [ + 'title' => '集成配置key', + 'type' => 'string', + ], + 'status' => [ + 'title' => '集成状态', + 'type' => 'string', + ], + 'dataSources' => [ + 'title' => '集成的数据源', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceIntegrationDataSource', + ], + ], + ], + ], + 'GrafanaWorkspaceIntegrationPreview' => [ + 'title' => '集成预览信息', + 'description' => 'Grafana集成项预览', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '预览大盘id', + 'type' => 'string', + ], + 'name' => [ + 'title' => '预览名称', + 'type' => 'string', + ], + 'thumbnail' => [ + 'title' => '缩略图地址', + 'type' => 'string', + ], + 'image' => [ + 'title' => '原图地址', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceMoveProcess' => [ + 'title' => 'Grafana迁移信息数据结构', + 'description' => 'Grafana迁移信息数据结构', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '备份配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'gmtCreate' => [ + 'title' => '配置创建时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'gmtModified' => [ + 'title' => '配置更新时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1680861352600', + ], + 'grafanaWorkspaceId' => [ + 'title' => 'Grafana工作区ID', + 'type' => 'string', + 'example' => 'grafana-cn-**********', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + ], + 'processName' => [ + 'title' => '配置名称', + 'type' => 'string', + ], + 'subType' => [ + 'title' => '配置类型', + 'type' => 'string', + 'example' => 'User', + 'enum' => [ + 'System', + 'User', + 'Restore', + ], + ], + 'processStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '配置信息', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceNews' => [ + 'title' => 'Grafana News', + 'description' => 'Grafana工作区快报信息', + 'type' => 'object', + 'properties' => [ + 'title' => [ + 'title' => 'News Title', + 'type' => 'string', + ], + 'image' => [ + 'title' => 'News Image URL', + 'type' => 'string', + ], + 'link' => [ + 'title' => 'News Detail Link', + 'type' => 'string', + ], + 'date' => [ + 'title' => 'News Date', + 'type' => 'integer', + 'format' => 'int64', + ], + 'description' => [ + 'title' => 'News Description', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceOperateLog' => [ + 'title' => '操作日志', + 'description' => 'Grafana工作区操作日志', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '日志id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'date' => [ + 'title' => '操作时间', + 'type' => 'number', + 'format' => 'float', + ], + 'grafanaWorkspaceId' => [ + 'title' => '工作区ID', + 'type' => 'string', + ], + 'detail' => [ + 'title' => '操作明细', + 'type' => 'string', + ], + 'operatorId' => [ + 'title' => '操作人用户ID', + 'type' => 'string', + ], + ], + ], + 'GrafanaWorkspaceOrg' => [ + 'title' => 'org', + 'description' => 'Grafana组织', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '组织id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'name' => [ + 'title' => '组织名称', + 'type' => 'string', + 'example' => 'main org', + ], + ], + ], + 'GrafanaWorkspaceTrans' => [ + 'title' => '数据迁移记录', + 'description' => 'Grafana数据迁移记录', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '记录主键id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'gmtCreate' => [ + 'title' => '创建时间', + 'type' => 'number', + 'format' => 'float', + ], + 'gmtModified' => [ + 'title' => '更新时间', + 'type' => 'number', + 'format' => 'float', + ], + 'grafanaWorkspaceId' => [ + 'title' => '工作区ID', + 'type' => 'string', + ], + 'userId' => [ + 'title' => '用户id', + 'type' => 'string', + ], + 'authType' => [ + 'title' => '授权方式', + 'type' => 'string', + ], + 'processStatus' => [ + 'title' => '迁移状态', + 'type' => 'string', + ], + 'msg' => [ + 'title' => '迁移信息', + 'type' => 'string', + ], + 'apiUrl' => [ + 'title' => '迁移侧Grafana地址', + 'type' => 'string', + ], + 'transDetails' => [ + 'title' => '迁移明细', + 'type' => 'array', + 'items' => [ + '$ref' => '#/components/schemas/GrafanaWorkspaceTransDetail', + ], + ], + ], + ], + 'GrafanaWorkspaceTransDetail' => [ + 'title' => '迁移明细', + 'description' => 'Grafana数据迁移明细', + 'type' => 'object', + 'properties' => [ + 'original' => [ + 'title' => '迁移侧grafana的组织id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'originalName' => [ + 'title' => '迁移侧grafana的组织名称', + 'type' => 'string', + ], + 'target' => [ + 'title' => '目标侧grafana的组织id', + 'type' => 'integer', + 'format' => 'int64', + ], + 'targetName' => [ + 'title' => '目标侧grafana的组织名称', + 'type' => 'string', + ], + 'dataSourceAmount' => [ + 'title' => '处理的数据源数量', + 'type' => 'integer', + 'format' => 'int32', + ], + 'dashboardAmount' => [ + 'title' => '处理的大盘数量', + 'type' => 'integer', + 'format' => 'int32', + ], + ], + ], + 'GrafanaWorkspaceUserCert' => [ + 'title' => '用户阿里云SSL证书', + 'description' => '用户阿里云证书', + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'title' => '证书ID', + 'type' => 'string', + 'example' => '8096753', + ], + 'name' => [ + 'title' => '证书名称', + 'type' => 'string', + 'example' => 'cert-7700050 [grafana.tongtong-max.cn]', + ], + ], + ], + 'GrafanaWorkspaceUserOrg' => [ + 'title' => '用户组织关系', + 'description' => 'Grafana用户组织关系', + 'type' => 'object', + 'properties' => [ + 'orgId' => [ + 'title' => '组织id', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'orgName' => [ + 'title' => '组织名称', + 'type' => 'string', + 'example' => 'main org', + ], + 'role' => [ + 'title' => '角色', + 'type' => 'string', + 'example' => 'admin', + ], + ], + ], + 'GrafanaWorkspaceVpcConfig' => [ + 'title' => 'VPC Config', + 'description' => 'Grafana工作区VPC数据通道配置', + 'type' => 'object', + 'properties' => [ + 'securityGroupId' => [ + 'title' => '安全组ID', + 'type' => 'string', + 'example' => 'sg-6we94uvybteyc******', + ], + 'vSwitchId' => [ + 'title' => '交换机ID', + 'type' => 'string', + 'example' => 'vsw-6we3**********', + ], + 'regionId' => [ + 'title' => '地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'vpcId' => [ + 'title' => 'VPC ID', + 'type' => 'string', + 'example' => 'vpc-6wehr2x**********', + ], + 'name' => [ + 'title' => '配置名称', + 'type' => 'string', + 'example' => '北京VPC-A通道', + ], + 'installStatus' => [ + 'title' => '配置状态', + 'type' => 'string', + 'example' => 'CreateSucceed', + 'enum' => [ + 'Creating', + 'CreateSucceed', + 'CreateFailed', + 'Deleting', + 'DeleteSucceed', + 'DeleteFailed', + ], + ], + 'fcConfig' => [ + 'title' => '通道类型', + 'type' => 'string', + 'example' => 'fc、ansm', + ], + 'id' => [ + 'title' => '配置ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'userId' => [ + 'title' => '用户ID', + 'type' => 'string', + 'example' => '10983***********', + ], + 'installMsg' => [ + 'title' => '安装信息', + 'type' => 'string', + ], + 'ipSections' => [ + 'title' => '路由策略', + 'type' => 'string', + 'example' => '192.168.0.0/24', + ], + ], + ], + 'GrafanaWorkspaceVpcRegion' => [ + 'title' => 'Grafana VPC 地域信息', + 'description' => 'Grafana工作区VPC数据通道地域信息', + 'type' => 'object', + 'properties' => [ + 'regionId' => [ + 'title' => '地域ID', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'regionName' => [ + 'title' => '地域名称', + 'type' => 'string', + 'example' => '华北2（北京）', + ], + ], + ], + 'GrafanaWorkspaceVpcRegionDetail' => [ + 'title' => 'Grafana 未安装通道VPC地域详情', + 'description' => 'Grafana工作区VPC数据通道地域信息详情', + 'type' => 'object', + 'properties' => [ + 'vpcId' => [ + 'title' => 'VPC ID', + 'type' => 'string', + 'example' => 'vpc-2ze4siu98**********', + ], + 'name' => [ + 'title' => 'VPC名称', + 'type' => 'string', + 'example' => 'vpc-abc*****', + ], + 'regionId' => [ + 'title' => 'VPC所在地域', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'userId' => [ + 'title' => 'VPC所属用户ID', + 'type' => 'string', + 'example' => '10988**********', + ], + 'installStatus' => [ + 'title' => '安装状态', + 'type' => 'string', + 'example' => 'Uninitialized', + 'enum' => [ + 'Uninitialized', + 'DeleteSucceed', + 'DeleteFailed', + ], + ], + 'securityGroupIds' => [ + 'title' => 'VPC 安全组列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'sg-*********', + ], + ], + 'vSwitchIds' => [ + 'title' => 'VPC 交换机列表', + 'type' => 'array', + 'items' => [ + 'type' => 'string', + 'example' => 'vsw-**********', + ], + ], + 'id' => [ + 'title' => 'ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '配置ID', + ], + 'fcConfig' => [ + 'title' => '网络类型', + 'type' => 'string', + 'example' => 'fc、ansm', + ], + 'securityGroupId' => [ + 'title' => '上次选择安全组ID', + 'type' => 'string', + ], + 'vSwitchId' => [ + 'title' => '上次选择交换机ID', + 'type' => 'string', + ], + ], + ], + 'QueryDataResponse' => [ + 'title' => '通用数据查询返回对齐Grafana返回的数据查询格式', + 'description' => '通用数据查询返回，对齐Grafana格式', + 'type' => 'object', + 'properties' => [ + 'results' => [ + 'title' => '以RefID为key的多数据返回', + 'type' => 'string', + ], + ], + ], + ], + ], + 'apis' => [ + 'QueryMetricByPage' => [ + 'summary' => '分页查询应用监控或前端监控的相关监控指标。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'IntervalInSec', + 'in' => 'query', + 'schema' => [ + 'description' => '数据片的时间间隔，单位为毫秒，最小值为60000。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '100000', + 'default' => '2147483647', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775806', + 'minimum' => '0', + 'example' => '1667287695000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775806', + 'minimum' => '0', + 'example' => '1667546895000', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序依据，可设为任一维度，请参见下文补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'pid', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的指标，不可自定义输入，请参见下文补充说明。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'appstat.host', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序标准。取值：'."\n" + ."\n" + .'- `ASC`：升序。'."\n" + .'- `DESC`：降序。'."\n" + ."\n" + .'> 不填则不排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码，默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '此参数已不支持使用。查询结果的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '筛选条件组合。', + 'type' => 'array', + 'items' => [ + 'description' => '参数结构体。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选条件组合，必须添加`pid`和`regionId`条件。', + 'type' => 'string', + 'required' => false, + 'example' => 'pid', + ], + 'Value' => [ + 'description' => '筛选条件组合，必须添加`pid`和`regionId`值，`pid`获取方式，请参见下文补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxx@74xxx', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指标对应的维度。', + 'type' => 'array', + 'items' => [ + 'description' => '指标对应的维度，请参见下文补充说明。最多可添加5个。', + 'type' => 'string', + 'required' => false, + 'example' => 'pid', + ], + 'required' => false, + 'example' => '["detector_browser","detector_device"]', + 'maxItems' => 15, + ], + ], + [ + 'name' => 'Measures', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指标对应的测量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '指标对应的测量数据，请参见下文补充说明。最多可添加5个。', + 'type' => 'string', + 'required' => false, + 'example' => 'instanceCount', + ], + 'required' => false, + 'example' => 'pv', + 'maxItems' => 15, + ], + ], + [ + 'name' => 'CustomFilters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '自定义过滤条件。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义过滤条件，多个过滤条件之间使用半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '["not rpcType:40","not rpcType:41"]', + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口状态，取值说明如下：'."\n" + ."\n" + .'- 2XX：成功。'."\n" + .'- 3XX：重定向。'."\n" + .'- 4XX：请求错误。'."\n" + .'- 5XX：服务器错误。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'StartTime is mandatory for this action.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '687F9CB7-4798-57BF-A6EE-E6CC76******', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '查询结果的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Total' => [ + 'description' => '查询结果的总项目数量。'."\n" + ."\n" + .'> 此参数的返回值为估算值，仅用于分页结束判断，不代表实际的数据总量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Page' => [ + 'description' => '查询结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Completed' => [ + 'description' => '分页查询是否结束。'."\n" + ."\n" + .'- true：结束。'."\n" + .'- false：需要继续分页（CurrentPage+1后继续查询）。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Items' => [ + 'description' => '返回数据。', + 'type' => 'array', + 'items' => [ + 'description' => '返回数据的数据结构体列表。', + 'type' => 'object', + '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.', + ], + ], + ], + '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' => '查询监控指标', + 'requestParamsDescription' => '## 如何获取应用pid'."\n" + .'在ARMS控制台左侧导航栏选择**应用监控 > 应用列表**或**前端监控 > 前端列表**，然后单击目标应用名称，以进入应用的总览页面。'."\n" + ."\n" + .'此时浏览器地址栏中的URL即包含前端应用的**pid**，格式为`pid=xxx`。由于浏览器进行了编码，应用需要对`xxx%40xxx`格式的pid稍作修改。例如，如果URL中包含的pid为`eb4zdose6v%409781be0f44d****`，则需要将`%40`替换为`@`，即：`eb4zdose6v@9781be0f44d****`。'."\n" + .'## 可查询的应用监控指标 '."\n" + ."\n" + .'> 请求参数**Filters**必须添加`pid`和`regionId`条件。已知具体的查询条件时，应将值传入**Filters**参数中，用于限定查询结果的范围。如果不知道具体的查询条件，可以将下表中的维度传入**Dimensions**参数，从而获得该维度所有可能值的列表。'."\n" + ."\n" + .'|指标（Metric）|描述|维度（Dimensions）|测量数据（Measures）|'."\n" + .'|---|---|---|---|'."\n" + .'| appstat.vm | 通用指标，对应应用详情下的JVM监控图表，包括GC指标、堆内存和非堆内存详情以及线程数。 |- pid <br />- rootIp<br /> |GC指标：<br />- youngGcCount：JVM监控Young GC次数<br />- oldGcCount：JVM监控Full GC次数<br />- youngGcTime：JVM监控Young GC耗时<br />- oldGcTime：JVM监控Full GC耗时<br />- youngGcCountInstant：JVM监控Young GC次数瞬时值<br />- oldGcCountInstant：JVM监控Full GC次数瞬时值<br />- youngGcTimeInstant：JVM监控Young GC耗时瞬时值<br />- oldGcTimeInstant：JVM监控Full GC耗时瞬时值<br />|'."\n" + .'| appstat.vm | 通用指标，对应应用详情下的JVM监控图表，包括GC指标、堆内存和非堆内存详情以及线程数。 |- pid<br />- rootIp<br /> |堆内存和非堆内存详情：<br />- edenSpace：年轻代eden区<br />- oldGen：老年代<br />- survivorSpace：年轻代survivor区<br />- metaSpace：元空间<br />- nonHeapCommitted：非堆内存<br />- nonHeapInit：非堆内存初始值<br />- nonHeapMax：非堆内存最大值<br />- nonHeapUsed：非堆内存使用量<br />- directUsed：对外内存中direct_buffer已使用的大小<br />- directCapacity：对外内存中direct_buffer的总大小<br /> |'."\n" + .'| appstat.vm | 通用指标，对应应用详情下的JVM监控图表，包括GC指标、堆内存和非堆内存详情以及线程数。 |- pid<br />- rootIp<br /> |线程数：<br />- threadCount：线程总数<br />- threadNewCount：新建线程数<br />- threadDeadlockCount：JVM内死锁的个数<br />- threadRunnableCount：JVM处于Runnable的线程个数<br />- threadTerminatedCount：终结线程数<br />- threadTimedWaitCount：处于timed_waiting状态的线程个数<br />- threadWaitCount：处于waiting状态的线程个数<br />- threadBlockedCount：阻塞线程数<br /> |'."\n" + .'| appstat.host | 主机监控，包括实例数、CPU、物理内存、磁盘、负载、网络流量（Bytes）和网络数据包数量。 |- pid<br />- rootIp<br /> |instanceCount：实例数 |'."\n" + .'| appstat.host | 主机监控，包括实例数、CPU、物理内存、磁盘、负载、网络流量（Bytes）和网络数据包数量。 |- pid<br />- rootIp<br /> |CPU：<br />- systemCpuIdle：最近5s的空闲CPU使用率，控制台页面未展示<br />- systemCpuSystem：最近5s的系统CPU使用率<br />- systemCpuUser：最近5s的用户CPU使用率<br />- systemCpuIoWait：最近5s的等待IO完成的CPU使用率<br /> |'."\n" + .'| appstat.host | 主机监控，包括实例数、CPU、物理内存、磁盘、负载、网络流量（Bytes）和网络数据包数量。 |- pid<br />- rootIp<br /> |物理内存：<br />- systemMemFree：当前系统的空闲内存（KB）<br />- systemMemUsed：当前系统的已经使用的内存（KB）<br />- systemMemTotal：当前系统的总内存（KB），控制台页面未展示<br />- systemMemBuffers：当前系统的buffer cache的内存数<br />- systemMemCached：当前系统的page cache里的内存数<br /> |'."\n" + .'| appstat.host | 主机监控，包括实例数、CPU、物理内存、磁盘、负载、网络流量（Bytes）和网络数据包数量。 |- pid<br />- rootIp<br /> |磁盘：<br />- systemDiskFree：磁盘空闲字节数<br />- systemDiskUsage：磁盘使用率<br />- systemDiskTotal：磁盘总字节数，公共云控制台页面未展示<br /> |'."\n" + .'| appstat.host | 主机监控，包括实例数、CPU、物理内存、磁盘、负载、网络流量（Bytes）和网络数据包数量。 |- pid<br />- rootIp<br /> |systemLoad：负载 |'."\n" + .'| appstat.host | 主机监控，包括实例数、CPU、物理内存、磁盘、负载、网络流量（Bytes）和网络数据包数量。 |- pid<br />- rootIp<br /> |网络：<br />- systemNetInPackets：最近30秒平均每秒网络接收到的报文数<br />- systemNetOutPackets：最近30秒平均每秒网络发送的字节数<br />- systemNetInErrs：最近30秒平均每秒网络接收的错误数<br />- systemNetOutErrs：最近30秒平均每秒网络发送的错误数<br />- systemNetInBytes：最近30秒平均每秒网络接收到的字节数<br />- systemNetOutBytes：最近30秒平均每秒网络发送的字节数<br /> |'."\n" + .'| appstat.database | 数据库调用。 |- pid<br />- rpcType：调用类型<br />- endpoint：数据库地址为localhost: 3306<br />- destId：库名为arms<br /> |- rt：响应时间，单位毫秒<br />- count：请求数<br />- error：错误数<br />- resultsize：仅支持Mysql 5.X版本<br />- slowcount：慢调用次数<br /> |'."\n" + .'| appstat.incall | 应用详情。 |- pid<br />- rpcType<br />- rootIp<br />- rpc<br />- ppid<br /> |- rt：响应时间，单位毫秒<br />- count：请求数<br />- error：错误数<br />- errorrate：错误率<br />- qps：每秒查询数<br />|'."\n" + .'| appstat.exception | 异常。 |- pid<br />- rpc<br />- endpoint<br />- excepType<br />- excepInfo<br /> |- rt：响应时间，单位毫秒<br />- count：请求数<br />- error：错误数<br /> |'."\n" + .'| appstat.sql | 慢SQL。 |- pid<br />- rpc<br />- endpoint<br />- sqlId<br /> |- rt：响应时间，单位毫秒<br />- count：请求数<br />- error：错误数<br />- slowcount：慢调用次数<br />- resultsize：仅支持Mysql 5.X版本<br />说明：slow=true时，limit条件不生效。<br /> |'."\n" + .'| appstat.mq.send | MQ发送。 |无 |- rt：响应时间，单位毫秒<br />- count：请求数<br />- error：错误数<br />- delay：调度延迟，单位毫秒<br /> |'."\n" + .'| appstat.mq.receive | MQ接收。 |无 |- rt：响应时间，单位毫秒<br />- count：请求数<br />- error：错误数<br />- delay：调度延迟，单位毫秒<br /> |'."\n" + .'| appstat.schedulerx | SchedulerX的调用量。 |- pid<br />- rpcType<br />- rootIp<br />- rpc<br /> |count：请求数 |'."\n" + .'| appstat.elasticsearch | Elasticsearch的调用量。 |- rpc<br />- endpoint<br />- opType：操作类型。例如index、search等。仅使用Elasticsearch rest high level client时支持。<br />|count：请求数 |'."\n" + .'| appstat.redis | Redis的调用量。 |- pid<br />- rpcType<br />- endpoint<br />- opType<br />- rpc<br />|count：请求数 |'."\n" + .'| appstat.status | 查询指定状态码下的调用次数（仅支持HTTP服务）。 |- pid<br />- rootIp<br />- rpc <br />|- 200：HTTP状态码为200（即正常）的调用次数<br />- 2xx：HTTP状态码以2开头（即正常）的调用次数<br />- 3xx：HTTP状态码为3开头的调用次数<br />- 4xx：HTTP状态码以4开头（即客户端错误）的调用次数<br />- 5xx：HTTP状态码以5开头（即服务端错误）的调用次数<br />|'."\n" + ."\n" + .'## 可查询的前端监控指标 '."\n" + ."\n" + .'您可以使用QueryMetric接口查询前端监控的以下指标。'."\n" + ."\n" + .'> 请求参数**Filters**必须添加`pid`和`regionId`条件。已知具体的查询条件时，应将值传入**Filters**参数中，用于限定查询结果的范围。如果不知道具体的查询条件，可以将下表中的维度传入**Dimensions**参数，从而获得该维度所有可能值的列表。'."\n" + ."\n\n" + ."\n\n" + .'|指标（Metric）|描述|维度（Dimensions）|测量数据（Measures）|'."\n" + .'|---|---|---|---|'."\n" + .'| webstat.api | API成功率 |- api（API请求地址，不带参数）<br />- detector_app_version（客户端版本）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- release（版本号）<br />- sr（屏幕分辨率）<br /> |- count（请求次数）<br />- rate（API成功率）<br />- avg_time（平均耗时）<br />|'."\n" + .'| webstat.api.detail | API详情 |- api（API请求地址，不带参数）<br />- ct（网络制式）<br />- detector_browser（浏览器）<br />- detector_browser_version（浏览器版本）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- detector_os_version（操作系统版本）<br />- domain（域名）<br />- ip_country_id（国家ID或区域ID）<br />- ip_isp（运营商）<br />- ip_region_id（中国省市ID）<br />- msg（返回信息）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />|- count（请求次数）<br />- fail_count（失败次数）<br />- fail_time（失败耗时）<br />- fail_uv（失败影响用户数）<br />- success_count（成功次数）<br />- success_rate（成功率）<br />- success_time（成功耗时）<br />|'."\n" + .'| webstat.apicost | API成功耗时 |- api（API请求地址，不带参数）<br />- code（返回状态码）<br />- detector_app_version（客户端版本）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- release（版本号）<br />- sr（屏幕分辨率）<br />|- count（成功次数）<br />- avg_time（成功耗时均值）<br />|'."\n" + .'| webstat.apifailtime | API失败耗时 |- api（API请求地址，不带参数）<br />- code（返回状态码）<br />- detector_app_version（客户端版本）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID） <br />- release（版本号）<br />- sr（屏幕分辨率）<br />|- count（错误次数）<br />- avg_time（失败耗时均值）<br />|'."\n" + .'| webstat.apimsg | API消息聚类 |- code（返回状态码）<br />- detector_app_version（客户端版本）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- msg（错误信息）<br />- release（版本号）<br />- sr（屏幕分辨率）<br />- success（1表示请求成功，0表示请求失败）<br />| count（请求次数） |'."\n" + .'| webstat.avg | 自定义统计：均值统计 |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- key（自定义Key）<br />- sr（屏幕分辨率）<br />|- count（总次数）<br />- pv（页面浏览量）<br />- uv（用户访问量）<br />- avg_val（平均值）<br />|'."\n" + .'| webstat.errcate | 错误聚类排行 |- msg（错误信息）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- sr（屏幕分辨率）<br />- release（版本号）<br />- environment（环境）<br />- detector_app_version（客户端版本）<br />- detector_app（客户端App）<br />| count（错误次数） |'."\n" + .'| webstat.index | 总览（访问量） |- ct（网络制式）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_isp（运营商）<br />- ip_region_id（中国省市ID）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />|- pv（页面浏览量）<br />- uv（独立访客）<br />|'."\n" + .'| webstat.msg.top | 页面高频错误 |- msg（错误信息）<br />- page（页面地址）<br />|- count（错误次数）<br />- error_uv（影响用户数）<br />- 影响用户率（影响用户数÷总UV）<br />|'."\n" + .'| webstat.perf.bucket | 对应ARMS前端监控控制台的**访问速度**页面上的性能样本分层图。 |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />|- cfpt（自定义首屏）<br />- ctti（自定义首次可交互）<br />- dns（DNS查询耗时）<br />- dom（DOM解析耗时）<br />- fmp（首屏时间）<br />- fpt（首次渲染时间）<br />- load（页面完全加载时间）<br />- ready（DOM Ready时间）<br />- res（资源加载耗时）<br />- ssl（SSL安全连接耗时）<br />- t1~t10（自定义性能指标）<br />- tcp（TCP连接耗时）<br />- trans（内容传输耗时）<br />- ttfb（请求响应耗时）<br />- tti（首次可交互时间）<br />|'."\n" + .'| webstat.perf.distribution | 对应ARMS前端监控控制台的**访问速度**页面上的性能分层图。 |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />|- cfpt（自定义首屏）<br />- ctti（自定义首次可交互）<br />- dns（DNS查询耗时）<br />- dom（DOM解析耗时）<br />- fmp（首屏时间）<br />- fpt（首次渲染时间）<br />- load（页面完全加载时间）<br />- ready（DOM Ready时间）<br />- res（资源加载耗时）<br />- ssl（SSL安全连接耗时）<br />- t1~t10（自定义性能指标）<br />- tcp（TCP连接耗时）<br />- trans（内容传输耗时）<br />- ttfb（请求响应耗时）<br />- tti（首次可交互时间）<br />|'."\n" + .'| webstat.resource | 资源错误排行 |- ct（网络制式）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_isp（运营商）<br />- ip_region_id（中国省市ID）<br />- node_name（错误类型）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />- src（资源信息）<br />| count（资源错误数） |'."\n" + .'| webstat.resource | 对应ARMS前端监控控制台的**总览**页面的资源弹层。 |- ct（网络制式）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_isp（运营商）<br />- ip_region_id（中国省市ID）<br />- node_name（错误类型）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />- src（资源信息）<br />| count（错误次数） |'."\n" + .'| webstat.satisfy | 满意度 |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- page（页面地址）<br />- sr（屏幕分辨率）<br />|- bad（不满意：fpt\\>8000）<br />- good（满意：fpt\\<2000）<br />- neutral（可容忍：fpt\\>2000且fpt\\<8000）<br />- satisfy（满意指数）<br />|'."\n" + .'| webstat.session | 慢加载追踪 | 无 |- browser_version（浏览器版本）<br />- browser（浏览器）<br />- date（开始时间）<br />- dom（DOM解析耗时）<br />- ip_country_id（国家ID或区域ID）<br />- ip_country（中国省市）<br />- ip_region_id（中国省市ID）<br />- ip_region（国家或区域）<br />- load（页面完全加载）<br />- page（页面地址）<br />- sid（会话ID）<br />|'."\n" + .'| webstat.speed | 访问速度 |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- release（版本号）<br />- sr（屏幕分辨率）<br />- page（页面地址）<br />- environment（环境）<br />|- avg_cfpt（自定义首屏）<br />- count（样本量）<br />- avg_ctti（自定义首次可交互）<br />- avg_dns（DNS查询耗时）<br />- avg_dom（DOM解析耗时）<br />- avg_fmp（首屏时间）<br />- avg_fpt（首次渲染时间）<br />- avg_load（页面完全加载时间）<br />- avg_ready（DOM Ready时间）<br />- avg_res（资源加载耗时）<br />- avg_ssl（SSL安全连接耗时）<br />- avg_t1~t10（自定义性能指标）<br />- avg_tcp（TCP连接耗时）<br />- avg_trans（内容传输耗时）<br />- avg_ttfb（请求响应耗时）<br />- avg_tti（首次可交互时间）<br />|'."\n" + .'| webstat.stable | 错误率排行 |- page（页面地址）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- sr（屏幕分辨率）<br />- msg（错误信息）<br />- release（版本号）<br />- environment（环境）<br />- detector_app_version（客户端版本）<br />- detector_app（客户端App）<br />|- count（样本量）<br />- error_pv（错误样本量）<br />- rate（JS错误率）<br />|'."\n" + .'| webstat.sum | 自定义统计：求和统计 |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- key（自定义key）<br />- sr（屏幕分辨率）<br />|- count（总次数）<br />- pv（页面浏览量）<br />- sum_val（总和）<br />- uv（独立访客）<br />|'."\n" + .'| webstat.url | 访问的URL |- detector_browser（浏览器）<br />- detector_device（设备）<br />- detector_os（操作系统）<br />- ip_country_id（国家ID或区域ID）<br />- ip_region_id（中国省市ID）<br />- sr（屏幕分辨率）<br />- uid<br />- username（用户名）<br />|- pv（页面浏览量）<br />- uv（独立访客）<br />|', + 'responseParamsDescription' => '**返回示例**'."\n" + ."\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' => '## 前端监控常见问题'."\n" + ."\n" + .'- 调用时为什么会出现RAM的权限问题？'."\n" + .' 这可能是由于该RAM角色没有权限，您可以为用户添加权限，请参见[借助RAM角色实现跨云账号访问资源](~~74785~~)。'."\n" + .'- 怎么拉取列表数据（不考虑时间粒度）？'."\n" + .' 将intervalInSec设置为2147483647。'."\n" + .'- 为什么返回的数据值都为0？'."\n" + .' - 请检查时间间隔是否设置过小，intervalInSec需要大于或等于60,000。'."\n" + .' - 请检查regionId是否设置正确，该regionId是根据日志接收的服务端划分的地域，而不是用户所在的地域，您可以根据项目的上报日志地址来区分regionId：'."\n" + .' - 华东1（杭州）地域前端监控上报日志地址：`https://arms-retcode.aliyuncs.com/r.png?`。'."\n" + .' - 新加坡地域前端监控上报日志地址：`https://arms-retcode-sg.aliyuncs.com/r.png?`。'."\n" + .' - 美国（硅谷）地域前端监控上报日志地址： `https://retcode-us-west-1.arms.aliyuncs.com/r.png?`。'."\n" + .'- 在调用模拟器或代码接口时为什么会报错？'."\n" + .' - 请检查regionId是否已填写，filters中是否已添加pid。'."\n" + .' - 查看对应指标的measures或dimensions是否正确，请参见上文**可查询的前端监控指标**。'."\n" + .'- 报错信息以及对应解决方案'."\n" + .' - **Metric查询错误，请联系管理员。**'."\n" + .' - 请检查Metric字段是否正确。'."\n" + .' - 请检查measures或dimensions是否正确。 '."\n" + .' - 请检查filters中是否已添加pid。'."\n" + .' - **InvalidIntervalInSec**'."\n" + .' 请检查intervalInSec是否超过最大值（2147483647）。 '."\n" + .' - **MissingMeasures**'."\n" + .' 请检查measures是否已填写。'."\n" + .' - **NonsequenceParameter.Dimensions**'."\n" + .' - 请检查dimensions是否已填写正确。'."\n" + .' - 请检查模拟器dimensions是否有多余的空格。'."\n" + .' - **ServiceUnavailable**'."\n" + .' 请检查regionId是否正确。'."\n" + .' - **前端监控地域不合法**'."\n" + .' 请检查regionId是否设置正确，该regionId是根据日志接收的服务端划分的地域，而不是用户所在的地域，您可以根据项目的上报日志地址来区分regionId： '."\n" + .' - 华东1（杭州）地域前端监控上报日志地址：`https://arms-retcode.aliyuncs.com/r.png?`。'."\n" + .' - 新加坡地域前端监控上报日志地址：`https://arms-retcode-sg.aliyuncs.com/r.png?`。'."\n" + .' - 美国（硅谷）地域前端监控上报日志地址： `https://retcode-us-west-1.arms.aliyuncs.com/r.png?`。'."\n" + .'- 为什么数据集中会缺失一些 measures或dimensions参数？'."\n" + .' 因为最多可设置5个measures和dimensions，如果超过5个，将导致参数无法返回。'."\n" + .'- 为什么一些指标的总数在聚合后明显少于未聚合时？例如：webstat.index聚合后求和的pv总数比未聚合时得到的pv总数少。'."\n" + .' 因为POP网关的限制，超出10,000条的数据将被去除，所以当聚合造成数据量超过限制时，返回的数据量比实际的量小，因此指标求和的总数会明显减少。您需要将每次请求后返回的数据量控制在10,000条以内，以获得准确的数据。', + ], + 'GetTraceApp' => [ + 'summary' => '获取应用监控任务详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b590lhguqs@d8deedfa9bf****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', + ], + 'TraceApp' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控任务类型：'."\n" + ."\n" + .'- `TRACE`：应用监控。'."\n" + ."\n" + .'- `RETCODE`：前端监控。', + 'type' => 'string', + 'example' => 'TRACE', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'arms-k8s-demo', + ], + 'UpdateTime' => [ + 'description' => '更新时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1635700348000', + ], + 'Show' => [ + 'description' => 'ARMS控制台是否显示该应用：'."\n" + ."\n" + .'- `true`：显示。'."\n" + ."\n" + .'- `false`：不显示。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1576599253000', + ], + 'Pid' => [ + 'description' => '应用的ID标识串。', + 'type' => 'string', + 'example' => 'b590lhguqs@d8deedfa9bf****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Labels' => [ + 'description' => '应用标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用标签。', + 'type' => 'string', + 'example' => '[ "test", "123123123", "uat" ],', + ], + ], + 'Tags' => [ + 'description' => '键值对标签。', + 'type' => 'array', + 'items' => [ + 'description' => '键值对标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'Source' => [ + 'description' => '应用来源。', + 'type' => 'string', + 'example' => 'ACSK8S', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + 'ClusterId' => [ + 'description' => '集群ID，仅容器场景下使用。', + 'type' => 'string', + 'example' => 'c905d1364c2dd4b6284a3f41790c4****', + ], + 'Language' => [ + 'description' => '编码语言。', + 'type' => 'string', + 'example' => 'java', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取应用监控任务详情', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAppJVMConfig' => [ + 'summary' => '获取应用各个实例的JVM配置信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => false, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1480521600000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1480607940000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Code' => [ + 'description' => '接口状态。'."\n" + ."\n" + .'- 2XX：成功。'."\n" + .'- 3XX：重定向。'."\n" + .'- 4XX：请求错误。'."\n" + .'- 5XX：服务器错误。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- true：操作成功 '."\n" + .'- false：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'JvmInfoList' => [ + 'description' => 'JVM信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'dsv9zcel92@1455182510c5369', + ], + 'VmArgs' => [ + 'description' => 'VM参数。', + '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' => '主机名。', + 'type' => 'string', + 'example' => 'host_name', + ], + 'Ip' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'example' => '47.91.59.244', + ], + 'AgentVersion' => [ + 'description' => 'Agent的版本。', + 'type' => 'string', + 'example' => '1.7.0-SNAPSHOT_3.0.3_3756244', + ], + 'ProcId' => [ + 'description' => '进程ID。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取应用各个实例的JVM配置信息', + ], + 'QueryAppTopology' => [ + 'summary' => '查询应用拓扑。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => [ + 'description' => '应用类型，XTRACE、EBPF需要填写，默认不填。', + 'type' => 'string', + 'required' => false, + 'example' => 'TRACE', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '拓扑查询类型。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'apm_txn' => '应用详情-接口调用拓扑图接口', + 'apm_app_v2' => '应用详情-应用拓扑图接口V2', + 'apm_database_v2' => '应用详情-数据库调用拓扑图接口V2', + 'apm_apps' => '应用列表-总览拓扑图接口', + 'apm_app' => '应用详情-应用拓扑图接口', + 'apm_txn_v2' => '应用详情-接口调用拓扑图接口V2', + 'apm_database' => '应用详情-数据库调用拓扑图接口', + 'apm_apps_v2' => '应用列表-总览拓扑图接口V2', + ], + 'example' => 'apm_apps_v2', + ], + ], + [ + 'name' => 'Rpc', + 'in' => 'query', + 'schema' => [ + 'description' => 'RPC接口名。', + 'type' => 'string', + 'required' => false, + 'example' => '/eventCenter', + ], + ], + [ + 'name' => 'Db', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'rm-xxx.mysql.rds.aliyuncs.com:3306', + ], + ], + [ + 'name' => 'DbName', + 'in' => 'query', + 'schema' => [ + 'description' => '数据库名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'orders', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1595568910000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1671952708499', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '筛选条件组合。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '筛选条件组合。', + 'example' => '"rootIp":"127.0.0.1"', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Success' => [ + 'description' => '查询是否成功：true：成功。 false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态，取值说明如下：2XX：成功。3XX：重定向。4XX：请求错误。5XX：服务器错误。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'Data' => [ + 'description' => '返回信息。', + '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" + .' }', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '查询拓扑图', + ], + 'GetAppApiByPage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775806', + 'minimum' => '0', + 'example' => '1600063200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => true, + 'maximum' => '9223372036854775806', + 'minimum' => '0', + 'example' => '1600066800000', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '1', + 'default' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '此参数已不支持使用。查询结果的每页项目数量。默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '1', + 'example' => '10', + 'default' => '10', + ], + ], + [ + 'name' => 'IntervalMills', + 'in' => 'query', + 'schema' => [ + 'description' => '数据片的时间间隔，单位为毫秒，最小值为60000，最大值为2147483647。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'maximum' => '2147483647', + 'minimum' => '0', + 'example' => '60000', + 'default' => '0', + ], + ], + [ + 'name' => 'PId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a2n80plglh@745eddxxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口状态。'."\n" + ."\n" + .'- 2XX：成功。'."\n" + .'- 3XX：重定向。'."\n" + .'- 4XX：请求错误。'."\n" + .'- 5XX：服务器错误。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', + ], + 'Success' => [ + 'description' => '查询是否成功。'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '返回结果的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'Total' => [ + 'description' => '返回结果的总项目数量。'."\n" + ."\n" + .'> 此参数的返回值为估算值，仅用于分页结束判断，不代表实际的数据总量', + 'type' => 'string', + 'example' => '2', + ], + 'Page' => [ + 'description' => '返回结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Completed' => [ + 'description' => '分页查询是否结束。'."\n" + ."\n" + .'- true：结束。'."\n" + .'- false：需要继续分页（CurrentPage+1后继续查询）。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Items' => [ + 'description' => '返回应用接口的黄金三指标数据', + 'type' => 'array', + 'items' => [ + 'description' => '接口的黄金三指标数据'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "date": 1691051460000, //发生时间'."\n" + .' "rt": 89.61016949152541, //平均响应时间'."\n" + .' "rpc": "/api/v1/info", //接口'."\n" + .' "count": 59, //请求数'."\n" + .' "error": 1 //错误数'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'example' => '[]', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'ParameterIllegal', + 'errorMessage' => 'The specified parameter is invalid.', + ], + [ + 'errorCode' => 'ParameterRegionIllegal', + 'errorMessage' => 'The specified region is invalid.', + ], + ], + 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.', + ], + ], + [ + [ + '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.', + ], + ], + ], + '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' => '查询接口的黄金三指标数据', + 'summary' => '通过分页的形式查询应用下每个接口的请求量、错误数、平均响应时间三种性能数据。可通过返回信息中的Completed字段判断分页是否结束。如未结束，CurrentPage参数加一后继续发起查询即可。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetTrace' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TraceID', + 'in' => 'query', + 'schema' => [ + 'description' => '调用链ID。可在ARMS控制台的**调用链路查询**页面或**接口快照**页面获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'ac14001a15954493811405707d****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', + 'description' => '开始时间的时间戳，精确到毫秒。'."\n" + .'>若TraceID长度为30，可不填；若TraceID长度不是30，则必填。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1623827602000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', + 'description' => '结束时间的时间戳，精确到毫秒。'."\n" + .'>若TraceID长度为30，可不填；若TraceID长度不是30，则必填。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1623827603000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的每页项目数量，最大值为100。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', + ], + 'Spans' => [ + 'description' => '调用链路详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SpanId' => [ + 'description' => 'Span ID。', + 'type' => 'string', + 'example' => '1234', + ], + 'OperationName' => [ + 'description' => '埋点的接口名称。', + 'type' => 'string', + 'example' => '/api/demo', + ], + 'ResultCode' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '222', + ], + 'Timestamp' => [ + 'description' => 'Span的产生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590388651', + ], + 'RpcType' => [ + 'description' => 'RPC类型：'."\n" + ."\n" + .'- -2 front'."\n" + .'- -3 app'."\n" + .'- 0 http'."\n" + .'- 25 http_client'."\n" + .'- 1 hsf_client'."\n" + .'- 2 hsf'."\n" + .'- 40 local'."\n" + .'- 41 async'."\n" + .'- 52 DB2'."\n" + .'- 53 Informix'."\n" + .'- 54 SequoiaDB'."\n" + .'- 55 Gbase'."\n" + .'- 56 GaussDB'."\n" + .'- 57 KingBase'."\n" + .'- 58 infuxdb'."\n" + .'- 59 clickhouse'."\n" + .'- 60 mysql'."\n" + .'- 61 mysql'."\n" + .'- 62 oracle'."\n" + .'- 63 postgresql'."\n" + .'- 64 mongodb'."\n" + .'- 65 ppas'."\n" + .'- 66 sqlserver'."\n" + .'- 67 mariadb'."\n" + .'- 68 dmdb'."\n" + .'- 69 oceanbase'."\n" + .'- 70 redis'."\n" + .'- 71 memcached'."\n" + .'- 72 elasticsearch'."\n" + .'- 73 kudu'."\n" + .'- 4 tddl'."\n" + .'- 5 tair'."\n" + .'- 13 mq_client'."\n" + .'- 252 mq'."\n" + .'- 23 kafka_client'."\n" + .'- 256 kafka'."\n" + .'- 3 notify_client'."\n" + .'- 254 notify'."\n" + .'- 7 dubbo_client'."\n" + .'- 8 dubbo'."\n" + .'- 11 dsf_client'."\n" + .'- 12 dsf'."\n" + .'- 9 grpc'."\n" + .'- 10 grpc_client'."\n" + .'- 16 thrift'."\n" + .'- 17 thrift_client'."\n" + .'- 18 sofa'."\n" + .'- 19 sofa_client'."\n" + .'- -1 unknown'."\n" + .'- 98 user_method'."\n" + .'- 100 root'."\n" + .'- 101 client'."\n" + .'- 102 server'."\n" + .'- 103 producer'."\n" + .'- 104 consumer'."\n" + .'- 105 db'."\n" + .'- 106 xtrace_other'."\n" + .'- 1301 schedulerx'."\n" + .'- 1302 XXL_Job'."\n" + .'- 1303 Spring_Scheduled'."\n" + .'- 1304 Quartz'."\n" + .'- 1305 ElasticJob'."\n" + .'- 1308 Jdk_Timer', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'ServiceIp' => [ + 'description' => '应用所在机器的IP地址。', + 'type' => 'string', + 'example' => '172.20.XX.XX', + ], + 'HaveStack' => [ + 'description' => '是否有方法栈：'."\n" + ."\n" + .'- `true`：有方法栈。'."\n" + .'- `false`：没有方法栈。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ParentSpanId' => [ + 'description' => '父Span ID。', + 'type' => 'string', + 'example' => '18', + ], + 'Duration' => [ + 'description' => '调用链路耗时，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1000', + ], + 'RpcId' => [ + 'description' => 'RPC ID。', + 'type' => 'string', + 'example' => '0', + ], + 'ServiceName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'arms-demo', + ], + 'TraceID' => [ + 'description' => '调用链路ID。', + 'type' => 'string', + 'example' => 'ac14001a15954493811405707d****', + ], + 'TagEntryList' => [ + 'description' => '调用链路的Tag列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的键。', + 'type' => 'string', + 'example' => 'http.status.code', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + 'LogEventList' => [ + 'description' => '调用链路中的日志事件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '日志事件的产生时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1590388651', + ], + 'TagEntryList' => [ + 'description' => '调用链路的Tag列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的键。', + 'type' => 'string', + 'example' => 'http.status.code', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + 'Children' => [ + 'description' => '当前Span的子Span的列表。', + 'type' => 'array', + 'items' => [ + 'description' => '子Span详情。', + '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" } ]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取调用链详情', + 'summary' => '加快获取调用链详情。', + 'description' => '>Java SDK需更新至版本v2.7.24。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetStack' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TraceID', + 'in' => 'query', + 'schema' => [ + 'description' => '调用链ID。您可以在ARMS控制台的**调用链分析**页面获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0a5800611641470044457853******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RpcID', + 'in' => 'query', + 'schema' => [ + 'description' => '接口ID，您可以通过调用**GetTrace**接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '0.1', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'eb4zdose6v@36bab313a******', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '调用方法的入口时间戳，单位ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1728351543000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '调用方法的结束时间戳，单位ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1728355143000', + ], + ], + [ + 'name' => 'SpanID', + 'in' => 'query', + 'schema' => [ + 'description' => '调用链SpanID。您可以在ARMS控制台的调用链分析页面获取。', + 'type' => 'string', + 'required' => false, + 'example' => '88c32dfa4b******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'B34C3A43-A901-5F94-9DAD-758CE4******', + ], + 'StackInfo' => [ + 'description' => '方法栈信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '调用方法的入口时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653555396', + ], + 'Exception' => [ + 'description' => '异常信息。', + 'type' => 'string', + 'example' => 'java.lang.NullPointerException', + ], + 'Api' => [ + 'description' => '接口名称。', + 'type' => 'string', + 'example' => 'Tomcat Servlet Process', + ], + 'Line' => [ + 'description' => '方法栈信息行数。', + 'type' => 'string', + 'example' => '34', + ], + 'Duration' => [ + 'description' => '耗时，单位为ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '32', + ], + 'RpcId' => [ + 'description' => 'RPC ID。', + 'type' => 'string', + 'example' => '0.1', + ], + 'ServiceName' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => '/com/test', + ], + 'CallCount' => [ + 'description' => '方法重复调用次数。', + 'type' => 'string', + 'example' => '1', + ], + 'ExtInfo' => [ + 'description' => '扩展信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '自定义参数信息类型。', + 'type' => 'string', + 'example' => '41', + ], + 'Info' => [ + 'description' => '自定义参数信息内容。', + 'type' => 'string', + 'example' => 'input=254275&', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'eventInfo' => [ + 'enable' => false, + 'eventNames' => [], + ], + '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' => '获取调用链方法栈', + 'summary' => '获取调用链方法栈信息。', + ], + 'GetMultipleTrace' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TraceIDs', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '调用链ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '调用链ID，最少填写1个，最多填写9个。可在ARMS控制台的**调用链路查询**页面获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'ac1400a115951745017447033d****', + ], + 'required' => true, + 'example' => 'ac1400a115951745017447033d****', + 'maxItems' => 10, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', + 'description' => '调用链路开始时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1657692507000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '当所传入的traceId非ARMS自动生成traceId时必须填写该字段', + 'description' => '调用链路结束时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1663999380000', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的页码，从1开始。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的查询数据条数，最大值1000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', + ], + 'MultiCallChainInfos' => [ + 'description' => '多个调用链路的信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'TraceID' => [ + 'description' => '调用链路ID。', + 'type' => 'string', + 'example' => 'ac1400a115951745017447033d****', + ], + 'Spans' => [ + 'description' => '调用链路详情信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SpanId' => [ + 'description' => 'Span ID。', + 'type' => 'string', + 'example' => '1234', + ], + 'OperationName' => [ + 'description' => '埋点的接口名称。', + 'type' => 'string', + 'example' => '/demo/queryNotExistDB/11', + ], + 'ResultCode' => [ + 'description' => '返回码。', + 'type' => 'string', + 'example' => '1', + ], + 'Timestamp' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1595174501747', + ], + 'RpcType' => [ + 'description' => 'RPC类型：'."\n" + ."\n" + .'- -2 front'."\n" + .'- -3 app'."\n" + .'- 0 http'."\n" + .'- 25 http_client'."\n" + .'- 1 hsf_client'."\n" + .'- 2 hsf'."\n" + .'- 40 local'."\n" + .'- 41 async'."\n" + .'- 52 DB2'."\n" + .'- 53 Informix'."\n" + .'- 54 SequoiaDB'."\n" + .'- 55 Gbase'."\n" + .'- 56 GaussDB'."\n" + .'- 57 KingBase'."\n" + .'- 58 infuxdb'."\n" + .'- 59 clickhouse'."\n" + .'- 60 mysql'."\n" + .'- 61 mysql'."\n" + .'- 62 oracle'."\n" + .'- 63 postgresql'."\n" + .'- 64 mongodb'."\n" + .'- 65 ppas'."\n" + .'- 66 sqlserver'."\n" + .'- 67 mariadb'."\n" + .'- 68 dmdb'."\n" + .'- 69 oceanbase'."\n" + .'- 70 redis'."\n" + .'- 71 memcached'."\n" + .'- 72 elasticsearch'."\n" + .'- 73 kudu'."\n" + .'- 4 tddl'."\n" + .'- 5 tair'."\n" + .'- 13 mq_client'."\n" + .'- 252 mq'."\n" + .'- 23 kafka_client'."\n" + .'- 256 kafka'."\n" + .'- 3 notify_client'."\n" + .'- 254 notify'."\n" + .'- 7 dubbo_client'."\n" + .'- 8 dubbo'."\n" + .'- 11 dsf_client'."\n" + .'- 12 dsf'."\n" + .'- 9 grpc'."\n" + .'- 10 grpc_client'."\n" + .'- 16 thrift'."\n" + .'- 17 thrift_client'."\n" + .'- 18 sofa'."\n" + .'- 19 sofa_client'."\n" + .'- -1 unknown'."\n" + .'- 98 user_method'."\n" + .'- 100 root'."\n" + .'- 101 client'."\n" + .'- 102 server'."\n" + .'- 103 producer'."\n" + .'- 104 consumer'."\n" + .'- 105 db'."\n" + .'- 106 xtrace_other'."\n" + .'- 1301 schedulerx'."\n" + .'- 1302 XXL_Job'."\n" + .'- 1303 Spring_Scheduled'."\n" + .'- 1304 Quartz'."\n" + .'- 1305 ElasticJob'."\n" + .'- 1308 Jdk_Timer', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ServiceIp' => [ + 'description' => '应用所在机器的IP地址。', + 'type' => 'string', + 'example' => '172.20.XX.XX', + ], + 'HaveStack' => [ + 'description' => '是否有方法栈：'."\n" + ."\n" + .'- `true`：有方法栈'."\n" + .'- `false`：没有方法栈', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ParentSpanId' => [ + 'description' => '父Span ID。', + 'type' => 'string', + 'example' => '18', + ], + 'Duration' => [ + 'description' => '调用链路耗时（毫秒）。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11', + ], + 'RpcId' => [ + 'description' => 'RPC ID', + 'type' => 'string', + 'example' => '0.1', + ], + 'ServiceName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'arms-k8s-demo-subcomponent', + ], + 'TraceID' => [ + 'description' => '调用链路ID。', + 'type' => 'string', + 'example' => 'ac1400a115951745017447033d****', + ], + 'TagEntryList' => [ + 'description' => '调用链路的Tag列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的主键。', + 'type' => 'string', + 'example' => 'http.status.code', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + 'LogEventList' => [ + 'description' => '调用链路中的日志事件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Timestamp' => [ + 'description' => '产生日志时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1595174501747', + ], + 'TagEntryList' => [ + 'description' => '调用链路的Tag列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的主键。', + 'type' => 'string', + 'example' => 'http.status.code', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => '200', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取多个调用链详情', + 'summary' => '获取多个调用链的详情。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ConfigApp' => [ + 'summary' => '打开或关闭应用监控的Agent总开关，或者查询Agent总开关的状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppIds', + 'in' => 'query', + 'schema' => [ + 'description' => '应用的ID标识串（PID）。多个PID以半角逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'iioe7jcnuk@582846f37******,atc889zkcf@d8deedfa9bf******', + ], + ], + [ + 'name' => 'Enable', + 'in' => 'query', + 'schema' => [ + 'description' => '打开或关闭一个或多个应用的Agent总开关。关闭开关后即停止监控。如果不填写该参数，则表示查询目标应用当前的Agent总开关状态。'."\n" + ."\n" + .'- `true`：打开Agent总开关'."\n" + .'- `false`：关闭Agent总开关', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '应用类型，目前仅支持设置为**TRACE**。', + 'type' => 'string', + 'required' => false, + 'example' => 'TRACE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功或者目标应用的Agent总开关状态。'."\n" + .'操作是否成功：'."\n" + ."\n" + .'- success'."\n" + .'- failed'."\n" + ."\n" + .'Agent总开关状态：'."\n" + .'- true'."\n" + .'- false', + 'type' => 'string', + 'example' => 'abc@def success\\nghi@jkl success\\n', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '必选参数不能为空', + ], + ], + ], + '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' => '打开或关闭应用监控总开关', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SaveTraceAppConfig' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'a2n80plglh@745eddxxx', + ], + ], + [ + 'name' => 'Settings', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '自定义设置列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义设置列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '自定义设置，各设置的详细字段见下文补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'sampling.enable', + ], + 'Value' => [ + 'description' => '自定义设置，各设置的详细字段见下文补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 256, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '接口状态码：2XX：成功 3XX：重定向 4XX：请求错误 5XX：服务器错误', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '应用监控自定义设置', + 'summary' => '进行应用监控的自定义设置（如调用链采样设置、Agent开关等）。', + 'requestParamsDescription' => '**采样设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------- | --------------------------- | ------------------------ |'."\n" + .'| sampling.rate | 固定比例采样采样率 | 0\\~100之间，默认为10。 |'."\n" + .'| sampling.useSamplingStrategyV2 | 是否使用自适应采样 | 取值：<br />- true：开启自适应采样。<br />- false（默认）：关闭自适应采样。 |'."\n" + .'| sampling.v2config.spanNames4FullSampleStr | 全采样接口名 | 示例: "/api/v1/user"。 |'."\n" + .'| sampling.v2config.spanNamePrefixes4FullSampleStr | 全采样接口前缀 | - |'."\n" + .'| sampling.v2config.spanNameSuffixes4FullSampleStr | 全采样接口后缀 | - |'."\n" + ."\n" + .'**探针开关设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ----------------------------- | ---------- | ------------------------------------------------------- |'."\n" + .'| enable | 探针开关 | 取值：<br />- true：开启监控。<br />- false（默认）：关闭监控。 |'."\n" + .'| akka.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| cassandra.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| dubbo.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| elasticsearch.enabled | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| elasticjob.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| googlehttpclient.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| grpc.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| hsf.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| httpclient3.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| httpclient4.enable | 插件开关 | 取值：-<br /> true（默认）<br />- false |'."\n" + .'| influxdb.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| jdbc.druid.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| jdbc.hikaricp.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| jdkhttp.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| jetty.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| liberty.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| mongodb.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| memcached.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| mysql.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| netty.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| okhttp.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| oracle.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| postgresql.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| play.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| quartz.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| redis.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| redis.redisson.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| lettuce.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| reactor.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| rabbitmq.client.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| kafka.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| onsclient.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| rxjava.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| schedulerx.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| servlet.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| spring.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| springBean.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| tomcat.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| vertx.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| weblogic.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| undertow.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| motan.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| ning.asynchttpclient.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| xxljob.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| mybatis.enable | 插件开关 | 取值：<br />- true（默认）<br />- false |'."\n" + ."\n" + .'**应用日志关联配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ---------------------------------- | ------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| logging.enable | 关联业务日志与 TraceId 开关 | 取值：<br />- true（默认）：开启关联业务日志与 TraceId 开关。<br />- false：关闭关联业务日志与 TraceId 开关。<br />开启后业务日志中会自动生成调用链的 TraceId。 |'."\n" + .'| logging.injectTraceId2Log.enable | 是否自动往用户日志注入TraceId | 取值：<br />- true<br />- false（默认） |'."\n" + .'| logging.injectSpanId2Log.enable | 是否自动往用户日志注入SpanId | 取值：<br />- true<br />- false（默认） |'."\n" + .'| logging.inject2MDC.enable | 是否往用户MDC放置Trace上下文 | 取值：<br />- true<br />- false（默认） |'."\n" + .'| SLS.bindType | 关联类型 | 取值：<br />- logstore<br />- storeview |'."\n" + .'| SLS.project | 当前区域业务日志的 project | 当前区域业务日志的 project。 |'."\n" + .'| SLS.logStore | 当前区域业务日志的 logstore | 当前区域业务日志的 logstore。 |'."\n" + .'| SLS.index | 当前区域业务日志的关联索引 | 取值：<br /> - 当指定全文索引时，不传。 <br />- 指定字段索引时，取值为相应的字段名。例如：SLS.index: tag。 字段索引及全文索引的区别，请参见配置索引。 |'."\n" + .'| SLS.storeView | StoreView名称 | 当前区域业务日志的 StoreView。 |'."\n" + ."\n" + .'**URL收敛设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| --------------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| convergence.enable | 收敛 URL | 取值：<br />- true（默认）：开启收敛 URL。<br />- false：关闭收敛 URL。 |'."\n" + .'| convergence.minServerSize | 收敛阈值 | 默认1000，大于此阈值即进行收敛。 |'."\n" + .'| convergence.pattern | 收敛规则正则表达式 | 可使用正则表达式设置收敛规则，多个正则表达式之间以英文逗号（,）分隔，直接填写 URL 原文表示不收敛此 URL，例如：/service/(.\\*?)/demo。 |'."\n" + ."\n" + .'**Arthas监控**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------ | -------------- | ---------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| arthas.enable | Arthas 开关 | 取值：<br />- true（默认）：开启 Arthas 开关。<br />- false：关闭 Arthas 开关。 |'."\n" + .'| arthas.enableIps | 生效实时 IP | 配置启用 Arthas 诊断的 IP，如果填写，Arthas 诊断仅对特定 IP 有效，不填写则默认对所有 IP 生效。多个 IP 请使用英文逗号（,）分割。 |'."\n" + ."\n" + .'**持续性能剖析设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------ | ---------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- |'."\n" + .'| cp.enable | 持续剖析开关 | 取值：<br />- true：开启持续剖析开关。<br />- false：关闭持续剖析开关。<br />该开关开启后，需要配置生效 IP或生效网段。 |'."\n" + .'| cp.cpuEnable | 是否开启CPU热点 | 取值：<br />- true<br />- false |'."\n" + .'| cp.cpuInterval | 采样频率，每次线程执行CPU耗时达到阈值后进行CPU热点方法栈采集。从4.x版本探针开始生效。 | 取值范围1~1000ms，默认值：10ms |'."\n" + .'| cp.allocEnable | 是否开启内存热点 | 取值：<br />- true<br />- false |'."\n" + .'| cp.allocInterval | 采样阈值，每次线程申请对应大小堆内存后进行内存热点方法栈采集。 从4.x版本探针开始生效。 | 取值范围256~10240KB，默认值：1024KB |'."\n" + .'| cp.wallClockEnable | 是否开启代码热点 | 取值：<br />- true<br />- false |'."\n" + .'| cp.wallClockInterval | 采样频率，每次线程运行相关时长后进行代码热点方法栈采集。从4.x版本探针开始生效。 | 取值范围1~1000ms，默认值：10ms | '."\n" + .'| cp.allowIPs | 生效IP。指定生效的IP地址，多个IP用英文逗号分隔。 | 示例：10.10.1.1,10.10.1.2 |'."\n" + .'| cp.allowNetwork | 生效网段。3.2.x+版本探针支持0.0.0.0/0地址。 | 示例：192.0.0.0/8 |'."\n" + ."\n" + .'**信息脱敏设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| sanitizer.enable | 信息脱敏开关 | 取值：<br />- true（默认）：开启信息脱敏开关。 <br /> - false：关闭信息脱敏开关。 |'."\n" + .'| sanitizer.keys | 脱敏规则 | 默认支持如示例规则，对 key 进行直接匹配，以 password 为例，规则等同于正则式 .*password.*，不分区大小写。多个规则之间以英文逗号分隔。 <br />示例：password,secret,key,token,credentials |'."\n" + ."\n" + .'**接口调用配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------------------ | --------------------------------------------------- | ---------------------------------------------------------------------------------- |'."\n" + .'| thresholds.interface | 慢调用阈值 | 默认为 500，单位为 ms。当接口响应时间大于该阈值的时候，该接口会被标记为慢调用。 |'."\n" + .'| error.skip | 错误码过滤，配置的HTTP状态码不会被统计为错误调用 | 示例值："404,403"。 |'."\n" + .'| defined.excludeurl | 无效接口调用过滤 | 支持以英文逗号（,）分隔多个接口调用。 <br />示例：/service/taobao,/service/status。 |'."\n" + .'| metrics.prpc.enable | 接口调用指标是否记录上游接口名 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| metrics.ppid.enable | 接口调用指标是否记录上游应用名 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| http.metrics.recordHttpCode | 接口调用指标是否记录原始状态码 | 取值：<br />- true<br />- false（默认） |'."\n" + ."\n" + .'**数据库调用配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| --------------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| thresholds.sql | 慢SQL阈值。当SQL查询的耗时大于该阈值的时候，该查询会被标记为慢SQL。 | 默认为 500，单位为 ms。 |'."\n" + .'| callsql.maxLength | 采集SQL最大保留长度。当SQL语句大于该阈值的时候，会被截断。 | 默认为 1024 个字符，最小长度为 256 个字符，最大长度为 4096 个字符。 |'."\n" + .'| jdbc.tracesqlbindvalue | 是否展示SQL中的变量绑定值 | 取值：<br />- true：开启捕获 PrepareStatement 参数绑定变量值开关。<br />- false（默认）：关闭捕获 PrepareStatement 参数绑定变量值开关。 |'."\n" + .'| jdbc.tracesqlraw | 是否展示SQL中的常量值 | 取值：<br />- true<br />- false（默认） |'."\n" + .'| preparestatement.response.size | 是否记录MySql查询返回值大小 | 取值：<br />- true<br />- false（默认） |'."\n" + ."\n" + .'**Trace上下文传播协议设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| -------------------------- | ---------------- | ------------------------------------------------------------------------ |'."\n" + .'| trace.protocol.name | 首选传播协议 | 可配置为EagleEye、W3C、Skywalking、Zipkin、Jager。 |'."\n" + .'| trace.protocol.strategy | 传播模式 | 首选传播协议的传播策略，默认未Unset，可设置为PriorityUse或ForceUse。 |'."\n" + ."\n" + .'**消息队列配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| -------------------------- | ---------------- | ------------------------------------------------------------------------ |'."\n" + .'| rabbitmq.client.consumer.classes | 自定义RabbitMQ消费者。通过设置自定义消费者的类名或者包含匿名内部消费者的类名，可以看到该消费者的调用链路。 | 多个消费者以英文半角逗号（,）分隔。示例：com.xxx.xxx.RabbitMQConsumer |'."\n" + .'| kafka.consumer.entryPoint | 自定义Kafka消费方法。通过自定义消费方法，可以在通过Kafka原生SDK消费消息的场景下看到链路以及指标数据。 | 需要设置的自定义消费方法的需要包含一个类型为org.apache.kafka.clients.Consumer.ConsumerRecord或者org.apache.kafka.clients.consumer.ConsumerRecords的参数。 |'."\n" + .'| kafka.enableInjectKafkaHeaders | kafka发送消息自动透传上下文。发送时自动往Kafka消息中添加若干个Header用于关联发送链路和消费链路。 | 取值：<br />- true<br />- false （默认） |'."\n" + ."\n" + .'**探针采集配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------- |'."\n" + .'| sampling.enable | 是否采集调用链 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| thresholds.limit | 探针每秒最大链路采集量。保护性手段，防止大流量场景下因为链路采集影响业务正常运行。高于默认值会消耗额外的系统资源，请您谨慎操作！ | 默认值：100 |'."\n" + .'| control.flow.threshold | 探针最大可处理QPS阈值。每秒请求量超过该阈值后，超出部分请求不再记录span和生成指标，探针4.1.10版本开始生效。 | 默认值：10000 |'."\n" + .'| metricsAndSpan.entranceless.enable | 是否采集无入口内部调用的数据 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| log.report.level | 探针日志级别 | DEBUG、INFO、WARN（默认）、ERROR |'."\n" + ."\n" + .'**异常高级过滤配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| exception.fromInstrumentedMethod.enable | 是否采集插件异常。 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| exception.stacktrace | 同类异常堆栈区分深度 | 默认为2。基于此堆栈深度识别同类型的异常。修改此配置会造成非预期的统计行为，请您谨慎操作！ |'."\n" + .'| exception.whitelist | 异常过滤白名单 | 默认值：""。<br />示例值："java.lang.RuntimeException"。 |'."\n" + .'| exception.filterByParentClass | 异常过滤父类继承。打开后，异常过滤中可配置父类异常。所有继承该父类的异常都会被过滤。该功能仅支持4.1.6及以上版本探针。 | 取值：<br />- true<br />- false（默认） |'."\n" + .'| exception.advancedWhitelist | 异常message过滤。 | 默认值：""。<br />示例：[{"exceptionName":"java.lang.RuntimeException","messageStartsWith":"prefixString"},{"exceptionName":"java.lang.NullPointerException","messageEndsWith":"suffixString"},{"exceptionName":"java.lang.IndexOutOfBoundsException","messageContains":"keyword"}]<br />对于上面配置，当满足下述条件时对应的异常会被过滤：<br />异常为java.lang.RuntimeException 且异常message以prefixString开头。<br />异常为java.lang.NullPointerException 且异常message以suffixString结尾。<br />异常为java.lang.IndexOutOfBoundsException 且异常message包含keyword关键字。 |'."\n" + ."\n" + .'**池化监控配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ----------------------------------------------------- | ---------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |'."\n" + .'| threadpoolmonitor.enable | 线程池、连接池监控 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| threadpoolmonitor.threadNamePatternExtractStrategy | 线程池线程名模式提取策略 | REPLACE\\_ALL\\_DIGITAL代表将线程名中所有数字替换为得到线程名模式。<br />REPLACE_TAIL_DIGITAL代表将线程名中结尾的数字替换为得到线程名模式。 |'."\n" + .'| threadpoolmonitor.threadPoolUsage.blacklist | 线程池使用场景过滤。不采集的线程池线使用场景，如果线程池的使用场景匹配上，则该线程池不监控。 | 默认值：""。<br />示例值："Tomcat,Vertx"。 |'."\n" + .'| threadpoolmonitor.threadNamePattern.blacklist | 线程池线程名模式过滤。不采集的线程池线程名模式黑名单，如果线程池的线程名模式匹配上，则该线程池不监控。 | 默认值：""。<br />示例值："http-nio-\\*-\\*, pool-1-thread-\\*"。 |'."\n" + ."\n" + .'**Span Attribute配置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| -------------------------- | --------------------------------- | ---------------------------------------------------------------------------------------- |'."\n" + .'| otel.attribute.enable | 记录OTel Spec 约定attributes | 取值：<br />- true<br />- false（默认） |'."\n" + .'| tags.injection.strategy | Span关联应用标签配置 | ALL\\_SPAN代表对标签会注入到所有的span中。<br />INCOMING_SPAN代表标签仅会注入到入口span中。 |'."\n" + ."\n" + .'**高级设置**'."\n" + ."\n" + .'| Key | 字段说明 | Value |'."\n" + .'| ----------------------------- | ------------------------------------------------------------- | ------------------------------------------------------------- |'."\n" + .'| quantile.enable | 是否记录分位数指标 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| callstack.maxLength | 方法堆栈最大保留长度 | 默认为128。超出长度的方法栈将会在采集的时候被截断。高于默认值会消耗额外的系统资源，请您谨慎操作！ |'."\n" + .'| compress.enable | 调用链压缩，是否将重复调用（比如 for 循环）简化。 | 取值：<br />- true（默认）<br />- false |'."\n" + .'| param.maxLength | 请求入参最大展示长度 | 默认为 512。高于默认值会消耗额外的系统资源，请谨慎操作。 |'."\n" + .'| thread.match.package | 异步透传扫描包名。4.x以上探针自动支持异步透传，无需配置。 | - |'."\n" + .'| responseInject.enable | HTTP返回结果中包含TraceId | 取值：<br />- true<br />- false（默认） |'."\n" + .'| metrics.jvm.captureGcCause | 是否记录JVM GC Cause信息。探针需升级到4.4.0版本。 | 取值：<br />- true<br />- false（默认） |', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetTraceAppConfig' => [ + 'summary' => '查询应用监控中，某个应用的全部自定义设置（如调用链采样设置、Agent开关等）。此接口仅适用于接入应用监控的应用，不适用于接入可观测链路 OpenTelemetry 版的应用。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'您可以通过以下两种方法获取Pid：'."\n" + ."\n" + .'- API：[ListTraceApps - 获取指定地域下全部应用监控任务的列表](~~2588008~~)。'."\n" + ."\n" + .'- 控制台：在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的Pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对Pid稍作修改。例如，如果URL中包含的Pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。'."\n" + ."\n\n" + .'><notice>'."\n" + ."\n" + .'- 通过控制台获取Pid的方法，仅适用于接入应用监控的应用，不适用于接入可观测链路 OpenTelemetry 版的应用。'."\n" + ."\n" + .'- 本文档所描述的接口GetTraceAppConfig，也仅支持查询接入应用监控的应用的自定义设置。'."\n" + ."\n" + .'></notice>', + 'type' => 'string', + 'required' => true, + 'example' => 'a2n80plglh@745eddxxx'."\n", + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****'."\n", + ], + 'Data' => [ + 'description' => '应用的自定义配置，格式为一个JSON字符串，每个配置的含义见**返回参数补充说明**。', + 'type' => 'string', + 'example' => '{"profiler":{"enable":true}}', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '查询应用配置成功', + ], + 'Code' => [ + 'description' => '接口状态码。', + 'type' => 'integer', + 'format' => 'int64', + 'enumValueTitles' => [ + '2xx' => '成功', + '3xx' => '重定向', + '4xx' => '请求错误', + '5xx' => '服务器错误', + ], + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功。', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '查询应用监控自定义设置', + 'responseParamsDescription' => '在返回的自定义配置中，各个JSONPath与对应的开关如下所示。'."\n" + .'（注：由于修改时机不同，返回的自定义配置中**可能不存在某项配置**，此时默认值将生效）'."\n" + ."\n" + .'**采样设置说明** '."\n" + ."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 采样策略 | profiler.sampling.useSamplingStrategyV2 | boolean | 取值：<br />- `true`：自适应采样。<br />- `false`：固定采样率。 | false |'."\n" + .'| 采样率百分比 | profiler.sampling.rate | double | 0~100之间。<br />固定采样率模式下生效。 | 10 |'."\n" + .'| 全采样接口名 | profiler.sampling.v2config.spanNames4FullSampleStr | String | 全采样接口名，多个由英文逗号分隔。 | 空字符串 |'."\n" + .'| 全采样接口前缀 | profiler.sampling.v2config.spanNamePrefixes4FullSampleStr | String | 全采样接口前缀。 | 空字符串 |'."\n" + .'| 全采样接口后缀 | profiler.sampling.v2config.spanNameSuffixes4FullSampleStr | String | 全采样接口后缀。 | 空字符串 |'."\n" + ."\n" + .'**探针开关设置说明**'."\n" + ."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 应用监控启停 | profiler.enable | boolean | 取值：<br />- `true`：开启应用监控。<br />- `false`：关闭应用监控。 | true |'."\n" + .'| dubbo插件开关 | profiler.dubbo.enable | boolean | 取值：<br />- `true`：开启dubbo插件。<br />- `false`：关闭dubbo插件。 | true |'."\n" + .'| mongodb插件开关 | profiler.mongodb.enable | boolean | 取值：<br />- `true`：开启mongodb插件。<br />- `false`：关闭mongodb插件。 | true |'."\n" + .'| hsf插件开关 | profiler.hsf.enable | boolean | 取值：<br />- `true`：开启hsf插件。<br />- `false`：关闭hsf插件。 | true |'."\n" + .'| httpclient3插件开关 | profiler.httpclient3.enable | boolean | 取值：<br />- `true`：开启httpclient3插件。<br />- `false`：关闭httpclient3插件。 | true |'."\n" + .'| httpclient4插件开关 | profiler.httpclient4.enable | boolean | 取值：<br />- `true`：开启httpclient4插件。<br />- `false`：关闭httpclient4插件。 | true |'."\n" + .'| jdkhttp插件开关 | profiler.jdkhttp.enable | boolean | 取值：<br />- `true`：开启jdkhttp插件。<br />- `false`：关闭jdkhttp插件。 | true |'."\n" + .'| jetty插件开关 | profiler.jetty.enable | boolean | 取值：<br />- `true`：开启jetty插件。<br />- `false`：关闭jetty插件。 | true |'."\n" + .'| mybatis插件开关 | profiler.mybatis.enable | boolean | 取值：<br />- `true`：开启mybatis插件。<br />- `false`：关闭mybatis插件。 | true |'."\n" + .'| mysql插件开关 | profiler.mysql.enable | boolean | 取值：<br />- `true`：开启mysql插件。<br />- `false`：关闭mysql插件。 | true |'."\n" + .'| okhttp插件开关 | profiler.okhttp.enable | boolean | 取值：<br />- `true`：开启okhttp插件。<br />- `false`：关闭okhttp插件。 | true |'."\n" + .'| oracle插件开关 | profiler.oracle.enable | boolean | 取值：<br />- `true`：开启oracle插件。<br />- `false`：关闭oracle插件。 | true |'."\n" + .'| postgresql插件开关 | profiler.postgresql.enable | boolean | 取值：<br />- `true`：开启postgresql插件。<br />- `false`：关闭postgresql插件。 | true |'."\n" + .'| redis插件开关 | profiler.redis.enable | boolean | 取值：<br />- `true`：开启redis插件。<br />- `false`：关闭redis插件。 | true |'."\n" + .'| spring插件开关 | profiler.spring.enable | boolean | 取值：<br />- `true`：开启spring插件。<br />- `false`：关闭spring插件。 | true |'."\n" + .'| springboot插件开关 | profiler.springboot.enable | boolean | 取值：<br />- `true`：开启springboot插件。<br />- `false`：关闭springboot插件。 | true |'."\n" + .'| tomcat插件开关 | profiler.tomcat.enable | boolean | 取值：<br />- `true`：开启tomcat插件。<br />- `false`：关闭tomcat插件。 | true |'."\n" + .'| lettuce插件开关 | profiler.lettuce.enable | boolean | 取值：<br />- `true`：开启lettuce插件。<br />- `false`：关闭lettuce插件。 | true |'."\n" + .'| grpc插件开关 | profiler.grpc.enable | boolean | 取值：<br />- `true`：开启grpc插件。<br />- `false`：关闭grpc插件。 | true |'."\n" + .'| thrift插件开关 | profiler.thrift.enable | boolean | 取值：<br />- `true`：开启thrift插件。<br />- `false`：关闭thrift插件。 | true |'."\n" + .'| hystrix插件开关 | profiler.hystrix.enable | boolean | 取值：<br />- `true`：开启hystrix插件。<br />- `false`：关闭hystrix插件。 | true |'."\n" + .'| rxjava插件开关 | profiler.rxjava.enable | boolean | 取值：<br />- `true`：开启rxjava插件。<br />- `false`：关闭rxjava插件。 | true |'."\n" + .'| memcached插件开关 | profiler.memcached.enable | boolean | 取值：<br />- `true`：开启memcached插件。<br />- `false`：关闭memcached插件。 | true |'."\n" + .'| druid插件开关 | profiler.jdbc.druid.enable | boolean | 取值：<br />- `true`：开启druid插件。<br />- `false`：关闭druid插件。 | true |'."\n" + .'| weblogic插件开关 | profiler.weblogic.enable | boolean | 取值：<br />- `true`：开启weblogic插件。<br />- `false`：关闭weblogic插件。 | true |'."\n" + .'| elasticjob插件开关 | profiler.elasticjob.enable | boolean | 取值：<br />- `true`：开启elasticjob插件。<br />- `false`：关闭elasticjob插件。 | true |'."\n" + .'| elasticsearch插件开关 | profiler.elasticsearch.enable | boolean | 取值：<br />- `true`：开启elasticsearch插件。<br />- `false`：关闭elasticsearch插件。 | true |'."\n" + .'| hikaricp插件开关 | profiler.jdbc.hikaricp.enable | boolean | 取值：<br />- `true`：开启hikaricp插件。<br />- `false`：关闭hikaricp插件。 | true |'."\n" + .'| influxdb插件开关 | profiler.influxdb.enable | boolean | 取值：<br />- `true`：开启influxdb插件。<br />- `false`：关闭influxdb插件。 | true |'."\n" + .'| kafka插件开关 | profiler.kafka.enable | boolean | 取值：<br />- `true`：开启kafka插件。<br />- `false`：关闭kafka插件。 | true |'."\n" + .'| netty插件开关 | profiler.netty.enable | boolean | 取值：<br />- `true`：开启netty插件。<br />- `false`：关闭netty插件。 | true |'."\n" + .'| play插件开关 | profiler.play.enable | boolean | 取值：<br />- `true`：开启play插件。<br />- `false`：关闭play插件。 | true |'."\n" + .'| reactor插件开关 | profiler.reactor.enable | boolean | 取值：<br />- `true`：开启reactor插件。<br />- `false`：关闭reactor插件。 | true |'."\n" + .'| redisson插件开关 | profiler.redis.redisson.enable | boolean | 取值：<br />- `true`：开启redisson插件。<br />- `false`：关闭redisson插件。 | true |'."\n" + .'| rabbitmq插件开关 | profiler.rabbitmq.client.enable | boolean | 取值：<br />- `true`：开启rabbitmq插件。<br />- `false`：关闭rabbitmq插件。 | true |'."\n" + .'| schedulerx插件开关 | profiler.schedulerx.enable | boolean | 取值：<br />- `true`：开启schedulerx插件。<br />- `false`：关闭schedulerx插件。 | true |'."\n" + .'| undertow插件开关 | profiler.undertow.enable | boolean | 取值：<br />- `true`：开启undertow插件。<br />- `false`：关闭undertow插件。 | true |'."\n" + .'| vertx插件开关 | profiler.vertx.enable | boolean | 取值：<br />- `true`：开启vertx插件。<br />- `false`：关闭vertx插件。 | true |'."\n" + .'| xxljob插件开关 | profiler.xxljob.enable | boolean | 取值：<br />- `true`：开启xxljob插件。<br />- `false`：关闭xxljob插件。 | true |'."\n" + .'| onsclient插件开关 | profiler.onsclient.enable | boolean | 取值：<br />- `true`：开启onsclient插件。<br />- `false`：关闭onsclient插件。 | true |'."\n" + .'| quartz插件开关 | profiler.quartz.enable | boolean | 取值：<br />- `true`：开启quartz插件。<br />- `false`：关闭quartz插件。 | true |'."\n" + .'| servlet插件开关 | profiler.servlet.enable | boolean | 取值：<br />- `true`：开启servlet插件。<br />- `false`：关闭servlet插件。 | true |'."\n" + .'| liberty插件开关 | profiler.liberty.enable | boolean | 取值：<br />- `true`：开启liberty插件。<br />- `false`：关闭liberty插件。 | true |'."\n" + .'| akka插件开关 | profiler.akka.enable | boolean | 取值：<br />- `true`：开启akka插件。<br />- `false`：关闭akka插件。 | true |'."\n" + .'| cassandra插件开关 | profiler.cassandra.enable | boolean | 取值：<br />- `true`：开启cassandra插件。<br />- `false`：关闭cassandra插件。 | true |'."\n" + .'| opentelemetry插件开关 | profiler.opentelemetry.enable | boolean | 取值：<br />- `true`：开启opentelemetry插件。<br />- `false`：关闭opentelemetry插件。 | true |'."\n" + .'| googlehttpclient插件开关 | profiler.googlehttpclient.enable | boolean | 取值：<br />- `true`：开启googlehttpclient插件。<br />- `false`：关闭googlehttpclient插件。 | true |'."\n" + .'| ning插件开关 | profiler.ning.asynchttpclient.enable | boolean | 取值：<br />- `true`：开启ning插件。<br />- `false`：关闭ning插件。 | true |'."\n" + ."\n" + .'**线程分析设置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 线程分析总控开关 | profiler.tprof.enableJvmThreadStatistic | boolean | 取值：<br />- `true`：开启线程分析。<br />- `false`：关闭线程分析。 | true |'."\n" + .'| 定期保存本地方法栈信息 | profiler.tprof.enableThreadStackRecorder | boolean | 取值：<br />- `true`：开启定期保存本地方法栈。<br />- `false`：关闭定期保存本地方法栈。 | false |'."\n" + .'| 高耗时调用阈值 | profiler.tprof. threadProfilerSlowInteractionRt | int | 单位ms，高于该阈值的调用会自动保存本地方法栈。 | 2000 |'."\n" + ."\n" + .'**应用日志关联配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 日志源 | profiler.logSource | String | 取值：<br />- `sls`：日志服务SLS。 | sls |'."\n" + .'| 自动关联业务日志与TraceId | profiler.logging.enable | boolean | 取值：<br />- `true`：开启关联功能。<br />- `false`：关闭关联功能。 | true |'."\n" + .'| 日志自动填充TraceId | profiler.logging.injectTraceId2Log.enable | boolean | 取值：<br />- `true`：开启自动填充功能。<br />- `false`：关闭自动填充功能。<br />探针版本**大于等于4.1.6**生效。 | true |'."\n" + .'| 日志自动填充SpanId | profiler.logging.injectSpanId2Log.enable | boolean | 取值：<br />- `true`：开启自动填充功能。<br />- `false`：关闭自动填充功能。<br />探针版本**大于等于4.1.6**生效。 | true |'."\n" + .'| 日志服务绑定-区域 | profiler.SLS.regionId | String | 关联日志源所在的地域。 | 空字符串 |'."\n" + .'| 日志服务绑定-Project | profiler.SLS.project | String | 关联日志源所属Project。 | 空字符串 |'."\n" + .'| 日志服务绑定-Logstore | profiler.SLS.logStore | String | 关联日志源Logstore。 | 空字符串 |'."\n" + .'| 日志服务绑定-关联索引 | profiler.SLS.index | String | 关联日志源索引。 | 空字符串 |'."\n" + ."\n" + .'**URL收敛配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 收敛URL | profiler.convergence.enable | boolean | 取值：<br />- `true`：开启收敛URL功能。<br />- `false`：关闭收敛URL功能。 | true |'."\n" + .'| 收敛阈值 | profiler.convergence.minServerSize | long | 大于此阈值进行收敛。 | 1000 |'."\n" + .'| 收敛规则 | profiler.convergence.pattern | String | 每条规则是一个正则表达式。<br />例：`/service/(.*?)/demo`。<br />多个规则之间以英文逗号分隔。 | 空字符串 |'."\n" + ."\n" + .'**Arthas配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| Arthas开关 | profiler.arthas.enable | boolean | 取值：<br />- `true`：开启Arthas功能。<br />- `false`：关闭Arthas功能。 | false |'."\n" + .'| 生效实时IP | profiler.arthas.enableIps | string | 开启Arthas功能的生效IP，多个IP用英文逗号分隔。<br />**空字符串表示对所有IP生效。** | 空字符串 |'."\n" + ."\n" + .'**持续剖析配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 总开关 | profiler.cp.enable | boolean | 取值：<br />- `true`：开启持续剖析功能。<br />- `false`：关闭持续剖析功能。<br />*该开关开启后，有两种配置模式，见下表。 | false |'."\n" + .'| CPU热点 | profiler.cp.cpuEnable | boolean | 取值：<br />- `true`：开启CPU热点功能。<br />- `false`：关闭CPU热点功能。 | false |'."\n" + .'| 内存热点 | profiler.cp.allocEnable | boolean | 取值：<br />- `true`：开启内存热点功能。<br />- `false`：关闭内存热点功能。 | false |'."\n" + .'| 代码热点 | profiler.cp.wallClockEnable | boolean | 取值：<br />- `true`：开启代码热点功能。<br />- `false`：关闭代码热点功能。 | false |'."\n" + ."\n" + .'<table>'."\n" + .'<tr><th bgcolor=#F5F5F5>模式</th><th bgcolor=#F5F5F5>Key</th><th bgcolor=#F5F5F5>字段说明</th><th bgcolor=#F5F5F5>Value</th></tr>'."\n" + .'<tr><td rowspan=2>IP白名单</td><td>cp.allowIPs</td><td>IP白名单</td><td>指定开启持续剖析的实例IP，多个IP请使用英文逗号（,）分割。<br />示例：192.168.0.1,192.168.0.2</td></tr>'."\n" + .'<tr><td>cp.allowNetwork</td><td>网段地址</td><td>请传递空字符串，否则将无法正常使用。</td></tr>'."\n" + .'<tr><td rowspan=2>网段地址</td><td>cp.allowIPs</td><td>IP白名单</td><td>请传递空字符串，否则将无法正常使用。</td></tr>'."\n" + .'<tr><td>cp.allowNetwork</td><td>网段地址</td><td>命中此网段地址范围的IP实例打开该功能。<br />示例：192.168.2.0/24</td></tr>'."\n" + .'</table>'."\n" + ."\n" + .'**信息脱敏配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 脱敏开关 | profiler.sanitizer.enable | boolean | 取值：<br />- `true`：开启脱敏功能。<br />- `false`：关闭脱敏功能。 | true |'."\n" + .'| 脱敏规则 | profiler.sanitizer.keys | String | 对敏感key包含词的匹配规则，不区分大小写，多个IP用英文逗号分隔。 | true |'."\n" + ."\n" + .'**接口调用配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 慢调用阈值 | profiler.thresholds.interface | long | 单位ms，高于该阈值的响应时间会被标记为慢调用。 | 500 |'."\n" + .'| 异常白名单 | profiler.exception.whitelist | String | 指定异常名正则表达式，白名单命中的异常不参与异常相关图表的统计，多个规则用英文逗号分隔。 | 空字符串 |'."\n" + .'| 异常过滤父类继承 | profiler.exception.filterByParentClass | boolean | 取值：<br />- `true`：开启该功能。<br />- `false`：关闭该功能。<br />打开后，异常过滤中可配置父类异常。<br />探针版本**大于等于4.1.6**生效。 | true |'."\n" + .'| HTTP状态码白名单 | profiler.error.skip | String | 指定忽略错误的HTTP状态码，白名单设置中的状态码将在错误统计中被忽略，多个状态码用英文逗号分隔。 | 空字符串 |'."\n" + .'| 无效接口调用过滤 | profiler.defined.excludeurl | String | 指定忽略的接口调用，每条规则是一个正则表达式，多个状态码用英文逗号分隔。 | /\\*\\*/\\*.jpg,/\\*\\*/\\*.png,/\\*\\*/\\*.js,<br />/\\*\\*/\\*.jpeg,/\\*\\*/\\*.pdf,/\\*\\*/\\*.xlsx,<br />/\\*\\*/\\*.txt,/\\*\\*/\\*.docs,/\\*\\*/\\*.gif,<br />/\\*\\*/\\*.csv |'."\n" + ."\n" + .'**数据库调用配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 慢SQL阈值 | profiler.thresholds.sql | long | 单位ms，高于该阈值的SQL调用会被标记为慢调用。 | 500 |'."\n" + .'| 采集SQL最大保留长度 | profiler.callsql.maxLength | long | 当SQL语句大于该阈值的时候，会被截断。 | 1024 |'."\n" + .'| 展示SQL中的变量绑定值 | profiler.jdbc.tracesqlbindvalue | boolean | 取值：<br />- `true`：开启该功能。<br />- `false`：关闭该功能。<br />开启后会捕获PrepareStatement参数绑定的变量值，并在页面展示。**仅支持MySQL**。 | false |'."\n" + .'| 展示SQL中的常量值 | profiler.jdbc. tracesqlraw | boolean | 取值：<br />- `true`：开启该功能。<br />- `false`：关闭该功能。<br />开启后捕获原始SQL语句。 | false |'."\n" + ."\n" + .'**调用链透传协议配置说明**'."\n" + ."\n" + .'****注：调用链透传协议配置仅在探针版本大于等于4.1.x时生效。****'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 透传协议 | profiler.trace.protocol.name | String | 取值：<br />- `Unset`：未设置。<br />- `W3C `：OpenTelemetry - W3C。<br />- `SkyWalking `：SkyWalking。<br />- `Zipkin `：Zipkin - B3。<br />- `Jaeger `：Jaeger。<br />- `EagleEye `：EagleEye。 | Unset |'."\n" + .'| 透传模式 | profiler.trace.protocol. strategy | String | 取值：<br />- `PriorityUse `：优先。<br />- `ForceUse `：强制。 | PriorityUse |'."\n" + ."\n" + .'**高级配置说明**'."\n" + .'| 配置说明 | JSONPath | Type | 备注 | 默认值 |'."\n" + .'|---|---|---|---|---|'."\n" + .'| 探针每秒最大链路采集量 | profiler.thresholds.limit | int | 保护性手段，防止大流量场景下因为链路采集影响业务正常运行。 | 100 |'."\n" + .'| 方法堆栈最大保留长度 | profiler.callstack.maxLength | int | 超出长度的方法栈将会在采集的时候被截断。<br />探针版本**大于等于4.0.0**已弃用该配置。 | 128 |'."\n" + .'| 同类异常堆栈区分深度 | profiler.exception.stacktrace | int | 基于此堆栈深度识别同类型的异常。 | 2 |'."\n" + .'| 请求入参最大展示长度 | profiler.param.maxLength | int | 请求入参最大展示的长度。 | 512 |'."\n" + .'| 自定义RabbitMQ消费者 | profiler.rabbitmq.client.consumer.classes | String | 指定RabbitMQ消费者的全类名，多个消费者用英文逗号分隔。<br />探针版本**大于等于4.0.0**已弃用该配置。 | 空字符串 |'."\n" + .'| 自定义Kafka消费方法 | profiler.kafka.consumer.entryPoint | String | 指定kafka消费者的消费。<br />探针版本**大于等于4.0.0**已弃用该配置。 | 空字符串 |'."\n" + .'| kafka发送消息自动透传上下文 | profiler.kafka.enableInjectKafkaHeaders | boolean | 发送时是否自动往kafka消息中添加若干个Header用以将发送链路以及消费链路关联。<br />探针版本**大于等于4.0.0**已弃用该配置。 | false |'."\n" + .'| 异步透传扫描包名 | profiler.thread.match.package | String | 当对应包名下的Runnable/Callable/Supplier在创建时，会自动捕获Trace上下文并传递到新线程。多个包名可采用英文逗号（,）分隔。<br />探针版本**大于等于4.0.0**已弃用该配置。 | 空字符串 |'."\n" + .'| HTTP返回结果中包含TraceId | profiler.responseInject.enable | boolean | 取值：<br />- `true`：开启返回TraceId的开关。<br />- `false`：关闭返回TraceId的开关。 | false |', + ], + 'DeleteTraceApp' => [ + 'summary' => '删除指定ID或类型的应用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的应用的ID，可调用SearchTraceAppByName接口获取。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '5406**', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的应用的类型，可调用SearchTraceAppByName接口获取，更多信息，请参见**SearchTraceAppByName**。包括以下类型：'."\n" + ."\n" + .'- `TRACE`：应用监控'."\n" + .'- `RETCODE`：前端监控', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TRACE', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在ARMS控制台的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '9w0sc5gxxz@edcsd447c2f****', + ], + ], + [ + 'name' => 'DeleteReason', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '删除原因。', + 'type' => 'object', + 'properties' => [ + 'Remark' => [ + 'description' => '其他删除原因的备注信息。', + 'type' => 'string', + 'required' => false, + 'example' => '业务场景覆盖不全', + ], + 'ReasonIds' => [ + 'description' => '删除原因ID。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '删除理由的ID。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Name' => [ + 'description' => '删除理由描述。', + '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":"其他原因"', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'JSON格式的返回结果，包含HTTP状态码、错误码、返回消息、TraceId等。', + 'type' => 'string', + 'example' => '{\\"code\\":200,\\"data\\":\\"{\\\\\\"code\\\\\\":200,\\\\\\"data\\\\\\":true,\\\\\\"errorCode\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"message\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"success\\\\\\":true,\\\\\\"traceId\\\\\\":\\\\\\"0bc0594d15954826692915817e****\\\\\\"}\\",\\"errorCode\\":\\"删除应用成功\\",\\"message\\":\\"删除应用成功\\",\\"success\\":true,\\"traceId\\":\\"0ab2646915954826692568137d****\\"}', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '接口状态码：2XX：成功 3XX：重定向 4XX：请求错误 5XX：服务器错误', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '删除指定ID和类型的应用', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'QueryReleaseMetric' => [ + 'summary' => '查询EDAS和K8s应用发布过程中不同版本的指标。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => 'EDAS或K8s应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => '8b46d03f-5947-449d-90fd-3a96c2******', + ], + ], + [ + 'name' => 'ChangeOrderId', + 'in' => 'query', + 'schema' => [ + 'description' => '发布单ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'a341a2f2-ed07-4257-aae9-dfb1be******', + ], + ], + [ + 'name' => 'ReleaseStartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '版本发布的开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1632798686692', + ], + ], + [ + 'name' => 'ReleaseEndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '版本发布的截止时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1632798718632', + ], + ], + [ + 'name' => 'CreateTime', + 'in' => 'query', + 'schema' => [ + 'description' => '发布单创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1634005438000', + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的指定接口。', + 'type' => 'string', + 'required' => false, + 'example' => 'clothservice', + ], + ], + [ + 'name' => 'MetricType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询的指标类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'SystemContrast', + ], + ], + [ + 'name' => 'ProxyUserId', + 'in' => 'query', + 'schema' => [ + 'description' => '当前参数暂不支持使用。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回的指标数据对比。', + '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' => '请求ID。', + 'type' => 'string', + 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', + ], + ], + ], + ], + ], + '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 \\"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' => '查看不同版本的指标', + ], + 'ListTraceApps' => [ + 'summary' => '获取指定地域下全部应用监控任务的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则关联应用的类型：'."\n" + ."\n" + .'- `TRACE`：应用监控。'."\n" + .'- `EBPF`：eBPF监控。', + 'type' => 'string', + 'required' => false, + 'example' => 'TRACE', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口状态码：'."\n" + ."\n" + .'- `2XX`：成功'."\n" + .'- `3XX`：重定向'."\n" + .'- `4XX`：请求错误'."\n" + .'- `5XX`：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息。', + 'type' => 'string', + 'example' => 'Internal error. Please try again. Contact the DingTalk service account if the issue persists after multiple retries.', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceApps' => [ + 'description' => '返回的应用监控列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '结构体', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控任务类型：'."\n" + ."\n" + .'- `TRACE`：应用监控'."\n" + .'- `RETCODE`：前端监控', + 'type' => 'string', + 'example' => 'TRACE', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test-app', + ], + 'UpdateTime' => [ + 'description' => '更新时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529667762000', + ], + 'Show' => [ + 'description' => 'ARMS控制台是否显示该应用：'."\n" + ."\n" + .'- `true`：显示'."\n" + .'- `false`：不显示', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529667762000', + ], + 'Pid' => [ + 'description' => '应用的ID标识串。', + 'type' => 'string', + 'example' => 'a5f9bdeb-2627-4dbe-9247-****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Labels' => [ + 'description' => '应用标签。', + 'type' => 'array', + 'items' => [ + 'description' => '应用标签值。', + 'type' => 'string', + 'example' => 'prod', + ], + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + 'Source' => [ + 'description' => '应用来源。', + 'type' => 'string', + 'example' => 'ACK', + ], + 'WorkloadName' => [ + 'description' => '工作负载名。', + 'type' => 'string', + 'example' => 'nginx-deployment ', + ], + 'WorkloadKind' => [ + 'description' => '工作负载类型。', + 'type' => 'string', + 'example' => 'Deployment', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'default', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'PHP', + ], + ], + ], + ], + ], + ], + ], + ], + 'errorCodes' => [ + 500 => [ + [ + 'errorCode' => 'InternalError', + 'errorMessage' => '必选参数不能为空', + ], + ], + ], + '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' => '获取指定地域下全部应用监控任务的列表', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchTraceAppByName' => [ + 'summary' => '按应用名称查询应用监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'TraceAppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围：1~128。'."\n" + ."\n" + .'`Tags`用于精确查找绑定了指定标签的弹性伸缩资源，由一个键值对组成。'."\n" + .'- 仅指定`Tags.Key`时，则返回关联该标签键的所有资源。'."\n" + .'- 仅指定`Tags.Value`时，则出现`MissingParameter.TagKey`的报错提示。'."\n" + .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的弹性伸缩资源会被查找到。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。非必填，可以为空字符串。最多支持128个字符，不能以```acs:```开头，不能包含```http://```或者```https://```。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'TraceApps' => [ + 'description' => '应用监控信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控任务类型：'."\n" + ."\n" + .'- `TRACE`：应用监控。'."\n" + .'- `RETCODE`：前端监控。', + 'type' => 'string', + 'example' => 'TRACE', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test-app', + ], + 'UpdateTime' => [ + 'description' => '更新时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593486786000', + ], + 'Show' => [ + 'description' => 'ARMS控制台中是否显示该应用：'."\n" + ."\n" + .'- `true`：显示。'."\n" + .'- `false`：不显示。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1593486786000', + ], + 'Pid' => [ + 'description' => 'PID。具体请参考[PID](https://help.alimama.com/?spm=a219t.23786078.0.0.290575a55P1LBx#!/search/index?spm=&keyWord=PID&knowledgeId=5625118&categoryId=1000040170)。'."\n" + .'> 使用V1.1.0及以上版本的SDK可用该字段。', + 'type' => 'string', + 'example' => 'a5f9bdeb-2627-4dbe-9247-****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Labels' => [ + 'description' => '应用别名。', + 'type' => 'array', + 'items' => [ + 'description' => '应用别名。', + 'type' => 'string', + 'example' => 'prod', + ], + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值(value)。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '按应用名称查询应用监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchTraceAppByPage' => [ + 'summary' => '分页查询应用监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TraceAppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的页码，如果不填写则默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果的每页项目数量，如果不填写则默认为`10`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值(value)。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4B446DF2-3DDD-4B5B-8E3F-D5225120****', + ], + 'PageBean' => [ + 'description' => '返回的页面信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '返回结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果的总项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'TraceApps' => [ + 'description' => '应用监控任务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控任务类型：'."\n" + ."\n" + .'- `TRACE`：应用监控。'."\n" + .'- `RETCODE`：前端监控。', + 'type' => 'string', + 'example' => 'TRACE', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'test-app', + ], + 'UpdateTime' => [ + 'description' => '更新时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1531291867000', + ], + 'Show' => [ + 'description' => '是否在ARMS控制台显示：'."\n" + ."\n" + .'- `true`：显示。'."\n" + .'- `false`：不显示。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1531291867000', + ], + 'Pid' => [ + 'description' => '应用的ID标识串。', + 'type' => 'string', + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Labels' => [ + 'description' => '应用别名列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用别名', + 'type' => 'string', + 'example' => 'prod', + ], + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值(value)。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '分页查询应用监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchTraces' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1595174400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1595210400000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-k8s-demo-subcomponent', + ], + ], + [ + 'name' => 'OperationName', + 'in' => 'query', + 'schema' => [ + 'description' => '埋点的接口名称。', + 'type' => 'string', + 'required' => false, + 'example' => '/demo/queryNotExistDB/11', + ], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '最小耗时，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '按照时间正序或者倒序排列。默认值为`false`。'."\n" + ."\n" + .'- `true`：表示倒序'."\n" + .'- `false`：表示正序'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '应用所在机器的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.XX.XX', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b590lhguqs@9781be0f44dXXXX', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的主键。系统预置字段如下：'."\n" + ."\n" + .'- serverApp：服务端应用名'."\n" + .'- clientApp：客户端应用名'."\n" + .'- service：接口名称'."\n" + .'- rpc：调用类型'."\n" + .'- msOfSpan：耗时大于'."\n" + .'- clientIp：客户端IP'."\n" + .'- serverIp：服务端IP'."\n" + .'- isError：是否异常调用', + 'type' => 'string', + 'required' => false, + 'example' => 'http.status_code', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'ExclusionFilters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用于排除的筛选条件结构体。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '用于排除的筛选条件的主键。', + 'type' => 'string', + 'required' => false, + 'example' => 'http.status_code', + ], + 'Value' => [ + 'description' => '用于排除的筛选条件的值。', + 'type' => 'string', + 'required' => false, + 'example' => '404', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'TraceInfos' => [ + 'description' => '返回的调用链路详细信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperationName' => [ + 'description' => '埋点的接口名称', + 'type' => 'string', + 'example' => 'get***', + ], + 'ServiceIp' => [ + 'description' => '应用所在机器的IP地址', + 'type' => 'string', + 'example' => '172.20.**.**', + ], + 'Duration' => [ + 'description' => '调用链路耗时（毫秒）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6', + ], + 'Timestamp' => [ + 'description' => '时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1595174436993', + ], + 'ServiceName' => [ + 'description' => '应用名称', + 'type' => 'string', + 'example' => 'arms-k8s-demo-subcomponent', + ], + 'TraceID' => [ + 'description' => '调用链路ID', + 'type' => 'string', + 'example' => 'ac1400a115951744369937024d****', + ], + 'SpanID' => [ + 'description' => '调用链路SpanID。', + 'type' => 'string', + 'example' => 'be3d6dcf5750e***', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询调用链列表信息', + 'summary' => '查询调用链列表信息，可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。', + 'description' => '>该接口最多返回100条数据。如需查询全量数据，建议使用SearchTracesByPage。具体详情，请参见[SearchTracesByPage](~~175866~~)。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchTracesByPage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1595174400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1595210400000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ServiceName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms-k8s-demo-subcomponent', + ], + ], + [ + 'name' => 'OperationName', + 'in' => 'query', + 'schema' => [ + 'description' => '埋点的接口名称。', + 'type' => 'string', + 'required' => false, + 'example' => '/demo/queryNotExistDB/11', + ], + ], + [ + 'name' => 'MinDuration', + 'in' => 'query', + 'schema' => [ + 'description' => '最小耗时，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Reverse', + 'in' => 'query', + 'schema' => [ + 'description' => '按照时间正序或者倒序排列。默认值为`false`。'."\n" + ."\n" + .'- `true`：表示倒序'."\n" + .'- `false`：表示正序'."\n" + ."\n", + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'ServiceIp', + 'in' => 'query', + 'schema' => [ + 'description' => '应用所在机器的IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '172.20.XX.XX', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的每页项目数量，最大值为100。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '5', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b590lhguqs@9781be0f44dXXXX', + ], + ], + [ + 'name' => 'ExclusionFilters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '用于排除的筛选条件的结构体。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '用于排除的筛选条件的主键。', + 'type' => 'string', + 'required' => false, + 'example' => 'http.status_code', + ], + 'Value' => [ + 'description' => '用于排除的筛选条件的值。', + 'type' => 'string', + 'required' => false, + 'example' => '404', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的主键。系统预置字段如下：'."\n" + ."\n" + .'- traceId：调用链ID'."\n" + .'- serverApp：服务端应用名'."\n" + .'- clientApp：客户端应用名'."\n" + .'- service：接口名称'."\n" + .'- rpc：调用类型'."\n" + .'- msOfSpan：耗时大于'."\n" + .'- clientIp：客户端IP'."\n" + .'- serverIp：服务端IP'."\n" + .'- isError：是否异常调用', + 'type' => 'string', + 'required' => false, + 'example' => 'http.status_code', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 5, + ], + ], + [ + 'name' => 'IsError', + 'in' => 'query', + 'schema' => [ + 'description' => '是否过滤错误的调用链。'."\n" + .'- `true`：过滤'."\n" + .'- `false`（默认）：不过滤', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'PageBean' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '返回结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Total' => [ + 'description' => '返回结果的总项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1601', + ], + 'TraceInfos' => [ + 'description' => '返回的调用链路详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'OperationName' => [ + 'description' => '埋点的接口名称。', + 'type' => 'string', + 'example' => '/demo/queryException/12', + ], + 'ServiceIp' => [ + 'description' => '应用所在机器的IP地址。', + 'type' => 'string', + 'example' => '172.20.XX.XX', + ], + 'Duration' => [ + 'description' => '调用链路耗时，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '679', + ], + 'Timestamp' => [ + 'description' => '时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1595174436994', + ], + 'ServiceName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'arms-k8s-demo-subcomponent', + ], + 'TraceID' => [ + 'description' => '调用链路ID。', + 'type' => 'string', + 'example' => 'ac1400a115951744369947025d****', + ], + 'SpanID' => [ + 'description' => '调用链路SpanID。', + 'type' => 'string', + 'example' => 'be3d6dcf5750e***', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '分页查询调用链列表信息', + 'summary' => '分页查询调用链列表信息，可根据时间、应用名称、IP地址、Span名称和Tag等信息筛选调用链。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetAgentDownloadUrlV2' => [ + 'summary' => '获取探针下载地址。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AgentType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要获取的 Agent 类型。<br />'."\n" + .'**枚举值：**'."\n" + .'* **JavaAgent**'."\n" + .'* **Instgo**', + 'type' => 'string', + 'required' => true, + 'example' => 'JavaAgent', + ], + ], + [ + 'name' => 'OsType', + 'in' => 'query', + 'schema' => [ + 'description' => '表示 Agent 工作环境的操作系统类型。<br />'."\n" + .'仅当 **AgentType** 为 **Instgo** 时，该参数有效，且为必填。<br />**枚举值：**'."\n" + .'* **linux**'."\n" + .'* **darwin**'."\n" + .'* **windows**', + 'type' => 'string', + 'required' => false, + 'example' => 'linux', + ], + ], + [ + 'name' => 'ArchType', + 'in' => 'query', + 'schema' => [ + 'description' => '表示 Agent 工作环境的架构类型。<br />'."\n" + .'仅当 **AgentType** 为 **Instgo** 时，该参数有效，且为必填。<br />**枚举值：**'."\n" + .'* **amd64**'."\n" + .'* **arm64**', + 'type' => 'string', + 'required' => false, + 'example' => 'amd64', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求 ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Data' => [ + 'description' => 'Agent 的版本号及下载 Url。', + 'type' => 'object', + 'properties' => [ + 'Version' => [ + 'description' => 'Agent 的版本号。', + 'type' => 'string', + 'example' => '3.2.9', + ], + 'Url' => [ + 'description' => 'Agent 的下载 Url。', + 'type' => 'string', + 'example' => 'http://arms-apm-cn-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/3.2.9/ArmsAgent.zip', + ], + ], + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '探针类型错误', + ], + 'Code' => [ + 'description' => '接口状态码。<br />'."\n" + .'**枚举值：**'."\n" + .'* 2xx：成功。'."\n" + .'* 3xx：重定向。'."\n" + .'* 4xx：请求错误。'."\n" + .'* 5xx：服务器错误。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功。<br />'."\n" + .'**枚举值：**'."\n" + .'* true：成功。'."\n" + .'* false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '获取探针下载链接V2', + ], + 'GetAgentDownloadUrl' => [ + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ArmsAgentDownloadUrl' => [ + 'description' => '探针下载链接。', + 'type' => 'string', + 'example' => 'http://arms-apm-hangzhou.oss-cn-hangzhou-internal.aliyuncs.com/2.7.1.1/', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '14043452-D486-4EA1-80C9-BA73FB81****', + ], + ], + ], + ], + ], + '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' => '获取探针下载链接', + 'summary' => '获取探针下载链接。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeTraceLicenseKey' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'LicenseKey' => [ + 'description' => '应用的LicenseKey。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'b590lhguqs@3a75d95f218****', + ], + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '29053944-6FE5-4240-8927-10095ECE****', + ], + ], + ], + ], + ], + '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' => '列出LicenseKey', + 'summary' => '列出LicenseKey。', + ], + 'ListInsightsEvents' => [ + 'summary' => '查询指定时间段内Insights的异常事件列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aokcdqn3ly@a195c6d6421****', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间的时间戳。', + 'type' => 'string', + 'required' => true, + 'example' => '1595174400000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间的时间戳。', + 'type' => 'string', + 'required' => true, + 'example' => '1480607940000', + ], + ], + [ + 'name' => 'InsightsTypes', + 'in' => 'query', + 'schema' => [ + 'description' => '获取事件类型，多个类型之间使用半角逗号（,）分隔，不填表示查询全部类型事件。'."\n" + ."\n" + .'- errorIncrease：某种类型（http dubbo）整体接口错误率突增事件'."\n" + .'- topErrorIncrease：流量Top 5接口错误率突增事件'."\n" + .'- topRtIncrease：某种类型（http dubbo）整体接口响应时间突增事件'."\n" + .'- rtIncrease：流量Top 5接口响应时间突增事件', + 'type' => 'string', + 'required' => false, + 'example' => 'errorIncrease,topErrorIncrease,topExceptionIncrease,topRtIncrease,rtIncrease', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6F1174DC-6085-5353-AAE7-D4ADCD******', + ], + 'InsightsEvents' => [ + 'description' => '事件详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Title' => [ + 'description' => '事件标题。', + 'type' => 'string', + 'example' => '应用服务整体平均响应时间突增', + ], + 'Desc' => [ + 'description' => '事件描述。', + 'type' => 'string', + 'example' => '应用【sd】【HTTP】服务整体的响应时间在【2022-07-27 10:57:00】出现突增', + ], + 'Type' => [ + 'description' => '事件类型。', + 'type' => 'string', + 'example' => 'rtIncrease', + ], + 'Pid' => [ + 'description' => '事件关联应用ID。', + 'type' => 'string', + 'example' => 'dsv9zcel92@7da413b******', + ], + 'Level' => [ + 'description' => '事件严重等级。', + 'type' => 'string', + 'example' => 'P3', + ], + 'Date' => [ + 'description' => '事件发生时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1658890560', + ], + 'ProblemId' => [ + 'description' => '问题标识。', + 'type' => 'string', + 'example' => 'erep3o9zue@01ebe697ab70566|@1499161100890550|@cn-hangzhou|@1701841800000|@1701842040000|@daa6c51a-3c44-4d57-9548-4e212c******', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询异常事件列表', + ], + 'QueryAppMetadata' => [ + 'summary' => '根据ID和类型查询编码映射内容。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'MetaIds', + 'in' => 'query', + 'schema' => [ + 'description' => '元数据ID列表，多个ID之间用英文半角逗号（,）分隔。'."\n" + ."\n" + .'您可以在ARMS控制台目标应用的**异常分析**页面获取异常ID。', + 'type' => 'string', + 'required' => true, + 'example' => '4c9dd447,3c76c565', + ], + ], + [ + 'name' => 'MetaType', + 'in' => 'query', + 'schema' => [ + 'description' => '元数据类型：'."\n" + ."\n" + .'- sql：通过sqlId获取SQL语句'."\n" + .'- exception：通过exceptionId返回异常堆栈', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'exception' => 'exception', + 'sql' => 'sql', + ], + 'example' => 'sql', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用的ID标识串，可以通过**ListTraceApps**接口获取。', + 'type' => 'string', + 'required' => true, + 'example' => 'ggxw4lnjuz@54364d85b******', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTimeMs', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + [ + 'name' => 'EndTimeMs', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '51877BAC-330C-5845-BDFD-C7859AD33FB7', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'example' => '{\'408d5533\': \'SELECT * FROM user_base_info\'}', + ], + 'Code' => [ + 'description' => '接口状态。'."\n" + ."\n" + .'- 2XX：成功。'."\n" + .'- 3XX：重定向。'."\n" + .'- 4XX：请求错误。'."\n" + .'- 5XX：服务器错误。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询编码映射内容', + ], + 'DeleteAppList' => [ + 'summary' => '根据应用监控PID列表，批量删除应用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pids', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => 'ARMS应用监控实例ID（即PID）列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用监控实例的PID。', + 'type' => 'string', + 'required' => false, + 'example' => '["atc889zkcf@d8deedfa9bfxxxx", "acd129bfcf@d5daebfa6cdxxxx"]', + ], + 'required' => true, + 'docRequired' => true, + 'maxItems' => 800, + ], + ], + ], + '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' => '4B446DF2-3DDD-4B5B-8E3F-D5225120****', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '"{\\"code\\":200,\\"data\\":\\"{\\\\\\"code\\\\\\":200,\\\\\\"data\\\\\\":true,\\\\\\"errorCode\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"message\\\\\\":\\\\\\"删除应用成功\\\\\\",\\\\\\"success\\\\\\":true,\\\\\\"traceId\\\\\\":\\\\\\"0bc1667516940677164677396d0088\\\\\\"}\\",\\"errorCode\\":\\"批量删除应用成功\\",\\"message\\":\\"批量删除应用成功\\",\\"success\\":true,\\"traceId\\":\\"210f470416940677161213505e0e7a\\"}"', + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息', + 'type' => 'string', + 'example' => '“批量删除应用成功”', + ], + 'Success' => [ + 'description' => '是否删除成功。取值：'."\n" + ."\n" + .'- `true`：删除成功'."\n" + .'- `false`：删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态码：2XX：成功 3XX：重定向 4XX：请求错误 5XX：服务器错误', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + ], + ], + ], + ], + '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', + ], + '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' => '批量删除应用', + ], + 'DoInsightsAction' => [ + 'summary' => '根据参数指定的模块类型，执行相应的动作。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '227392', + 'abilityTreeNodes' => [ + 'FEATUREarmsXHEL9X', + ], + ], + 'parameters' => [ + [ + 'name' => 'Module', + 'in' => 'formData', + 'schema' => [ + 'description' => '模块类型'."\n" + .'- QueryTopo '."\n" + .' '."\n" + .' 拓扑查询功能，拓扑由边和节点构成，每条边都有其对应的类型，每个节点都拥有一个对应的实体，每个实体都有其类型。通过设置边的类型、节点的类型，查询时间范围等过滤参数，可以过滤出需要的拓扑数据。'."\n" + ."\n" + .'- QueryTopoRed'."\n" + .' '."\n" + .' 拓扑RED指标(请求数、耗时、错误数)查询。在查询拓扑时，开启了指标查询选项的情况下，可能会由于拓扑过大导致无法查出所有的指标数据。此功能用于让使用者主动查询指定节点、指定边的指标数据。'."\n" + ."\n\n" + .'注意: 上述功能尚处于灰度中，默认不开启，如需要开启请联系arms值班号。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'QueryTopoRed' => '拓扑RED指标查询', + 'QueryTopo' => '拓扑查询', + ], + 'example' => 'QueryTopo', + ], + ], + [ + 'name' => 'Data', + 'in' => 'formData', + 'schema' => [ + 'description' => '查询参数，不同模块类型对应的查询参数不同。'."\n" + ."\n" + .'- QueryTopo'."\n" + .'```'."\n" + .'{'."\n" + .' "regionId": string, #区域ID'."\n" + .' "startTime": string, #开始时间 格式为yyyy-MM-dd HH:mm:ss'."\n" + .' "endTime": string, #结束时间 格式为yyyy-MM-dd HH:mm:ss'."\n" + .' "edgeFilter": { #边过滤条件'."\n" + .' "includeTypes": [enum], #需包含的边类型'."\n" + .' "excludeTypes": [enum], #需排除的边类型'."\n" + .' "fromNodeFilter": { #源节点过滤条件'."\n" + .' "includeEntityTypes": [enum] #需包含的实体类型'."\n" + .' "excludeEntityTypes": [enum] #需排除的实体类型'."\n" + .' },'."\n" + .' "toNodeFilter": { #目标节点过滤条件'."\n" + .' "includeEntityTypes": [enum] #需包含的实体类型'."\n" + .' "excludeEntityTypes": [enum] #需排除的实体类型'."\n" + .' }'."\n" + .' },'."\n" + .' "includeIsolatedNodes": boolean, #是否包含孤立节点'."\n" + .' "isolatedNodeFilter": { # 孤立节点过滤条件'."\n" + .' "includeEntityTypes": [enum] #需包含的实体类型'."\n" + .' "excludeEntityTypes": [enum] #需排除的实体类型'."\n" + .' },'."\n" + .' "queryMetrics": boolean, # 查询指标时，是否同步查询相关RED指标'."\n" + .' "timeoutSecs": int, # 指标查询超时时间'."\n" + .' "redOption": { #指标查询控制选项'."\n" + .' "skipRt": boolean, # 是否跳过查询RT指标'."\n" + .' "skipCount": boolean, # 是否跳过查询请求数指标'."\n" + .' "skipError": boolean # 是否跳过查询错误数指标'."\n" + .' }'."\n" + .'}'."\n" + ."\n" + .'```'."\n" + ."\n" + .'- QueryTopoRed'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "regionId": string, #区域ID'."\n" + .' "startTime": string, #开始时间 格式为yyyy-MM-dd HH:mm:ss'."\n" + .' "endTime": string, #结束时间 格式为yyyy-MM-dd HH:mm:ss'."\n" + .' "edgeIds": [string] #待查询的边id'."\n" + .' "nodeIds": [string] #待查询的节点id'."\n" + .' "redOption": { #指标查询控制选项'."\n" + .' "skipRt": boolean, # 是否跳过查询RT指标'."\n" + .' "skipCount": boolean, # 是否跳过查询请求数指标'."\n" + .' "skipError": boolean # 是否跳过查询错误数指标'."\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", + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => '626037F5-FDEB-45B0-804C-B3C92797A64E', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回参数类型与传入的module值相关。'."\n" + ."\n" + .'- QueryTopo'."\n" + .' ```'."\n" + .' {'."\n" + .' "nodes": [Object] #节点集合，详见返回参数补充说明中的Node定义'."\n" + .' "edges": [Object] #边集合，详见返回参数补充说明中的Edge定义'."\n" + .' }'."\n" + .' ```'."\n" + .'- QueryTopoRed'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' "nodeRed": {'."\n" + .' "nodeId": {'."\n" + .' "count": double, #查询时段的总请求数'."\n" + .' "error": double, #查询时段的总错误数'."\n" + .' "rt": double, #查询时段的平均耗时,单位毫秒'."\n" + .' }'."\n" + .' },'."\n" + .' "edgeRed": {'."\n" + .' "edgeId": {'."\n" + .' "count": double, #查询时段的总请求数'."\n" + .' "error": double, #查询时段的总错误数'."\n" + .' "rt": double, #查询时段的平均耗时,单位毫秒'."\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", + ], + ], + ], + ], + ], + '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' => '访问Insights相关的各种子功能', + 'requestParamsDescription' => '拓扑由边和节点构成，每条边都有其对应的类型，每个节点都拥有一个对应的实体，每个实体都有其类型。通过设置边的类型，节点的类型，查询时间范围等参数，可以过滤出需要的拓扑数据。'."\n" + ."\n\n" + .'- 孤立节点'."\n" + ."\n" + .' 孤立节点指该节点与其他节点不存在任何关系'."\n" + ."\n" + .'当字段类型为enum时，表示该字段的值来源于枚举，枚举的定义参见补充说明', + 'responseParamsDescription' => '- Node定义'."\n" + .' '."\n" + .' ```'."\n" + .' {'."\n" + .' "nodeId": string, #节点ID'."\n" + .' "entity": Object, #实体信息 根据type的不同,字段会有不同的差异,详见补充说明中的 实体信息 '."\n" + .' "attrs": { #扩展属性信息 '."\n" + .' "RED": { # RED指标'."\n" + .' "count": double, #查询时段的总请求量'."\n" + .' "error": double, #查询时段的总错误数'."\n" + .' "rt": double, # 查询时段的平均耗时，单位毫秒'."\n" + .' }'."\n" + .' }'."\n" + .' }'."\n" + .' ```'."\n" + ."\n\n" + .'- Edge定义'."\n" + ."\n" + .' ```'."\n" + .' {'."\n" + .' "from": string, #节点ID'."\n" + .' "to": string, #节点ID'."\n" + .' "type": enum, #详见补充说明中的 边类型'."\n" + .' "attrs": { #扩展属性信息'."\n" + .' "RED": { # RED指标'."\n" + .' "count": double, #查询时段的总请求量'."\n" + .' "error": double, #查询时段的总错误数'."\n" + .' "rt": double, #查询时段的平均耗时，单位毫秒'."\n" + .' }'."\n" + .' },'."\n" + .' "edgeId": string, #边ID'."\n" + .' "firstSeenTms": long, #第一次发现该边的时间，毫秒时间戳'."\n" + .' "lastSeenTms": long, #最后一次发现该边的时间，毫秒时间戳'."\n" + .' }'."\n" + ."\n" + .' ```', + 'extraInfo' => '- 实体类型'."\n" + .' '."\n" + .' - APPLICATION 应用实体，即常规的应用'."\n" + .' - RPC 接口实体'."\n" + .' - EXTERNAL_SERVICE 外部服务， 所有非APM可观测的服务，比如数据库服务、Redis服务等'."\n" + .' - APPLICATION_INST 应用实例实体，即运行应用的具体实例'."\n" + ."\n" + .'- 边类型'."\n" + ."\n" + .' - CALLS 指源节点的实体调用了目标节点的实体'."\n" + ."\n" + .' - CONTAINS 指源节点的实体拥有目标节点的实体'."\n" + ."\n" + .' - RUNS_ON 指源节点的实体运行在目标节点的实体上'."\n" + ."\n\n" + ."\n" + .'- 实体'."\n" + ."\n" + .' - APPLICATION '."\n" + .' - entityId string #实体ID'."\n" + .' - firstSeenTms long #第一次发现该实体的时间，毫秒时间戳'."\n" + .' - lastSeenTms: long #最后一次发现该实体的时间，毫秒时间戳'."\n" + .' - type enum # 实体类型,值为APPLICATION'."\n" + .' - regionId string # 应用部署区域'."\n" + .' - appType enum # 应用类型'."\n" + .' - appId string # 应用ID'."\n" + .' - name string # 应用名称'."\n" + ."\n" + .' - RPC'."\n" + .' - entityId string #实体ID'."\n" + .' - firstSeenTms long #第一次发现该实体的时间，毫秒时间戳'."\n" + .' - lastSeenTms: long #最后一次发现该实体的时间，毫秒时间戳'."\n" + .' - type enum # 实体类型,值为RPC'."\n" + .' - regionId string # 应用部署区域'."\n" + .' - appType enum # 接口所属应用的应用类型'."\n" + .' - appId string # 接口所属应用的id'."\n" + .' - appName string #接口所属应用的名称'."\n" + .' - rpcType enum #接口类型'."\n" + .' - rpc string #接口名称'."\n" + ."\n" + .' - ExternalService'."\n" + ."\n" + .' - entityId string #实体ID'."\n" + .' - firstSeenTms long #第一次发现该实体的时间，毫秒时间戳'."\n" + .' - lastSeenTms: long #最后一次发现该实体的时间，毫秒时间戳'."\n" + .' - type enum # 实体类型,值为EXTERNAL_SERVICE'."\n" + .' - rpcType enum #服务类型'."\n" + .' - serverAddr string #服务地址'."\n" + .' '."\n" + .' - ApplicationInstance'."\n" + ."\n" + .' - entityId string #实体ID'."\n" + .' - firstSeenTms long #第一次发现该实体的时间，毫秒时间戳'."\n" + .' - lastSeenTms: long #最后一次发现该实体的时间，毫秒时间戳'."\n" + .' - type enum # 实体类型,值为APPLICATION_INST'."\n" + .' - regionId string # 实例部署区域'."\n" + .' - appType enum # 应用类型'."\n" + .' - appId string # 应用id'."\n" + .' - appName string 应用名称'."\n" + .' - ip string #实例IP'."\n" + .' - agentInfo Object # 实例元信息'."\n" + ."\n" + .'- 应用类型'."\n" + ."\n" + .' - RUM 前端应用'."\n" + .' - XTRACE 通过Opentelemetry探针接入的应用'."\n" + .' - TRACE 通过ARMS探针接入的应用'."\n" + .' - EBPF 通过EBPF探针接入的应用'."\n" + ."\n" + .'- 接口类型'."\n" + .' '."\n" + .' 待补充'."\n" + ."\n" + .'- 外部服务类型'."\n" + .' '."\n" + .' 待补充'."\n" + ."\n" + .'- 实例元信息'."\n" + ."\n" + .' 待补充', + ], + 'Upload' => [ + 'summary' => '上传SourceMap到ARMS前端监控。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'SourceMap文件上传到的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在**ARMS控制台**的**前端监控** > **前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含前端应用的pid，格式为pid=xxx。由于浏览器进行了编码，应用需要对xxx%40xxx格式的pid稍作修改。例如，如果URL中包含的pid为eb4zdose6v%409781be0f44d****，则需要将%40替换为@，即：eb4zdose6v@9781be0f44d****。', + 'type' => 'string', + 'required' => true, + 'example' => 'b590lhguqs@8cc3f6354******', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => 'SourceMap文件名。', + 'type' => 'string', + 'required' => true, + 'example' => 'test.js.map', + ], + ], + [ + 'name' => 'Version', + 'in' => 'query', + 'schema' => [ + 'description' => '不推荐使用此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'File', + 'in' => 'formData', + 'schema' => [ + 'description' => 'SourceMap文件的String字符串内容。', + 'type' => 'string', + 'required' => false, + 'example' => 'test file content', + ], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => [ + 'description' => 'SourceMap文件版本。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'UploadResult' => [ + 'description' => '上传完成的返回数据。', + 'type' => 'object', + 'properties' => [ + 'Fid' => [ + 'description' => '文件ID。', + 'type' => 'string', + 'example' => '123', + ], + 'FileName' => [ + 'description' => 'SourceMap文件名称。', + 'type' => 'string', + 'example' => 'test.js.map', + ], + 'UploadTime' => [ + 'description' => '文件上传时间。', + 'type' => 'string', + 'example' => '1650272251', + ], + ], + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + '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' => '上传SourceMap', + ], + 'DeleteSourceMap' => [ + 'summary' => '删除前端监控中上传的SourceMap文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在**ARMS控制台**的**前端监控** > **前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为`pid=xxx`。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为`xxx%4074xxx`，则需要将**%40**替换为**@**，即：`xxx@74xxx`。', + 'type' => 'string', + 'required' => true, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'FidList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'SourceMap的ID标识串列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'SourceMap的ID标识串列表。格式为：`pid/sourcemap文件版本/sourcemap文件名`', + 'type' => 'string', + 'required' => false, + 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Data' => [ + 'description' => '执行结果。'."\n" + ."\n" + .'- success：删除成功。'."\n" + .'- false：删除失败。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '删除SourceMap文件', + ], + 'GetSourceMapInfo' => [ + 'summary' => '获取前端监控中上传的SourceMap文件详细信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ID', + 'in' => 'query', + 'schema' => [ + 'description' => 'SourceMap的ID标识串。格式为：`pid/sourcemap文件版本/sourcemap文件名`', + 'type' => 'string', + 'required' => true, + 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', + ], + ], + [ + 'name' => 'Keyword', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名中的关键字，按照关键字进行过滤查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'OrderField', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段：'."\n" + ."\n" + .'- version：以版本进行排序。'."\n" + .'- uploadTime：以上传时间排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'version', + ], + ], + [ + 'name' => 'AscendingSequence', + 'in' => 'query', + 'schema' => [ + 'description' => '是否正序排序：'."\n" + ."\n" + .'- true：正序排序。'."\n" + .'- false：逆序排序。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Edition', + 'in' => 'query', + 'schema' => [ + 'description' => 'SourceMap的版本。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'SourceMapList' => [ + 'description' => 'SourceMap的信息列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Fid' => [ + 'description' => 'SourceMap的ID标识串。', + 'type' => 'string', + 'example' => 'atc889zkcf@d8deedfa9bf****/0.0.0/test.sourcemap.js', + ], + 'FileName' => [ + 'description' => 'SourceMap文件名称。', + 'type' => 'string', + 'example' => 'test.sourcemap.js', + ], + 'Size' => [ + 'description' => '文件大小，单位为KB。', + 'type' => 'string', + 'example' => '201223', + ], + 'UploadTime' => [ + 'description' => '文件上传时间的时间戳。', + 'type' => 'string', + 'example' => '1590657842000', + ], + 'Version' => [ + 'description' => '文件版本。', + 'type' => 'string', + 'example' => '0.0.0', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取SourceMap文件详细信息', + ], + 'CreateRetcodeApp' => [ + 'summary' => '创建前端监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RetcodeAppName', + 'in' => 'query', + 'schema' => [ + 'description' => '前端监控应用名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'SdkTest', + ], + ], + [ + 'name' => 'RetcodeAppType', + 'in' => 'query', + 'schema' => [ + 'description' => '前端监控应用类型，包括：'."\n" + ."\n" + .'- `web`：Web页面'."\n" + .'- `weex`：Weex页面'."\n" + .'- `mini_dd`：钉钉小程序'."\n" + .'- `mini_alipay`：支付宝小程序'."\n" + .'- `mini_wx`：微信小程序'."\n" + .'- `mini_common`：其他小程序', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'mini_dd', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', + ], + 'Code' => [ + 'description' => '接口状态码：2XX：成功 3XX：重定向 4XX：请求错误 5XX：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'string', + 'example' => 'bdidt76ehx@d5cf1cd3f7df411', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RetcodeAppDataBean' => [ + 'description' => '返回前端监控创建信息。', + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'description' => 'PID。', + 'type' => 'string', + 'example' => 'aokcdqn3ly@a195c6d6421****', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '135143', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + 'Tags' => [ + 'type' => 'object', + 'itemNode' => true, + 'properties' => [ + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '创建前端监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetRetcodeShareUrl' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用PID。'."\n" + ."\n" + .'在ARMS控制台的**前端监控**>**前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'iioe7jcnuk@582846f37******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Url' => [ + 'description' => '前端监控站点的分享地址。', + 'type' => 'string', + 'example' => 'http://arms-daily.console.aliyun.com:8080/shareapi/retcode.json?login_arms_t3h_token=XXXxxx&action=RetcodeAction&eventSubmitDoGetData=1', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', + ], + ], + ], + ], + ], + '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' => '获取前端监控站点的分享地址', + 'summary' => '获取前端监控站点的分享地址。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteRetcodeApp' => [ + 'summary' => '删除前端监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用主键ID。您可以通过**GetRetcodeAppByPid**接口查询。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => '1231', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '前端监控应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '前端监控应用的标识串。', + 'type' => 'string', + 'required' => true, + 'example' => 'aokcdqn3ly@741623b4e91****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '是否成功删除：'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '附加信息。取值说明如下：请求正常，返回success。请求异常，返回具体异常信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除前端监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SetRetcodeShareStatus' => [ + 'summary' => '打开或关闭前端监控站点的免登录分享开关，打开该功能后即可通过调用GetRetcodeShareUrl接口获取的地址访问前端监控页面。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在**ARMS控制台**的**前端监控** > **前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含前端应用的pid，格式为pid=xxx。由于浏览器进行了编码，应用需要对xxx%40xxx格式的pid稍作修改。例如，如果URL中包含的pid为eb4zdose6v%409781be0f44d****，则需要将%40替换为@，即：eb4zdose6v@9781be0f44d****。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '设置前端监控站点的免登录分享开关的状态。取值：'."\n" + ."\n" + .'- `true`：开启。'."\n" + .'- `false`：关闭。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '前端监控应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-app', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', + ], + ], + ], + ], + ], + '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' => '打开或关闭前端监控站点的免登录分享开关', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListRetcodeApps' => [ + 'summary' => '列出指定地域下所有前端监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'headers' => [], + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', + ], + 'RetcodeApps' => [ + 'description' => '前端监控应用列表信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '前端应用名称。', + 'type' => 'string', + 'example' => 'A1', + ], + 'RetcodeAppType' => [ + 'description' => '接入的前端类型。'."\n" + ."\n" + .'- `web`：Web端。'."\n" + .'- `weex`：Weex端。'."\n" + .'- `mini_dd`：钉钉E应用。'."\n" + .'- `mini_alipay`：支付宝小程序。'."\n" + .'- `mini_wx`：微信小程序。'."\n" + .'- `mini_common`：其他类型小程序。', + 'type' => 'string', + 'example' => 'web', + ], + 'AppId' => [ + 'description' => '应用ID，数据库自增字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16064', + ], + 'Pid' => [ + 'description' => '应用的ID标识串。', + 'type' => 'string', + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + 'NickName' => [ + 'description' => '前端监控应用别名。', + 'type' => 'string', + 'example' => 'B1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '列出所有前端监控任务', + 'description' => '****', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchRetcodeAppByPage' => [ + 'summary' => '分页查询前端监控任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RetcodeAppName', + 'in' => 'query', + 'schema' => [ + 'description' => '前端监控应用名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'App1', + ], + ], + [ + 'name' => 'PageNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '当前查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'RetcodeAppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在**ARMS控制台**的**前端监控** > **前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为`pid=xxx`。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为`xxx%4074xxx`，则需要将**%40**替换为**@**，即：`xxx@74xxx`。', + 'type' => 'string', + 'required' => false, + 'example' => 'eb4zdose6v@9781be0f44d****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '626037F5-FDEB-45B0-804C-B3C92797A64E', + ], + 'PageBean' => [ + 'description' => '每页返回信息。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '当前查询页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数据行数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'TotalCount' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '8', + ], + 'RetcodeApps' => [ + 'description' => '每页返回前端监控任务信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '监控类型。'."\n" + ."\n" + .'- `TRACE`：应用监控。'."\n" + .'- `RETCODE`：前端监控。', + 'type' => 'string', + 'example' => 'RETCODE', + ], + 'AppName' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'a3', + ], + 'RetcodeAppType' => [ + 'description' => '接入的前端类型。'."\n" + ."\n" + .'- `web`：Web端。'."\n" + .'- `weex`：Weex端。'."\n" + .'- `mini_dd`：钉钉应用。'."\n" + .'- `mini_alipay`：支付宝小程序。'."\n" + .'- `mini_wx`：微信小程序。'."\n" + .'- `mini_common`：其他类型小程序。', + 'type' => 'string', + 'example' => 'web', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545363321000', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1545363321000', + ], + 'Pid' => [ + 'description' => '应用的ID标识串。', + 'type' => 'string', + 'example' => 'eb4zdose6v@9781be0f44d****', + ], + 'AppId' => [ + 'description' => '应用ID，数据库自增字段。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16064', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '12341234', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'NickName' => [ + 'description' => '应用别名。', + 'type' => 'string', + 'example' => 'c1', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'example' => 'TestValue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '分页查询前端监控任务', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetRetcodeLogstore' => [ + 'summary' => '获取指定账号下前端监控应用对应SLS存储的Project和Logstore。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。在ARMS控制台的**前端监控**>**前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '请求状态。', + 'type' => 'string', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '日志内容。', + 'type' => 'string', + 'example' => 'retcode app or task can not be found!', + ], + 'RetcodeSLSConfig' => [ + 'description' => 'SLS存储信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Project' => [ + 'description' => 'SLS存储的Project。', + 'type' => 'string', + 'example' => 'test-project', + ], + 'Logstore' => [ + 'description' => 'SLS存储Logstore。', + 'type' => 'string', + 'example' => 'log-test-220431', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取Project和Logstore', + ], + 'GetRetcodeDataByQuery' => [ + 'summary' => '根据SLS的查询语句查询前端监控的数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。'."\n" + ."\n" + .'在**ARMS控制台**的**前端监控** > **前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含前端应用的pid，格式为pid=xxx。由于浏览器进行了编码，应用需要对xxx%40xxx格式的pid稍作修改。例如，如果URL中包含的pid为eb4zdose6v%409781be0f44d****，则需要将%40替换为@，即：eb4zdose6v@9781be0f44d****。', + 'type' => 'string', + 'required' => true, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '符合SLS Logstore查询语法的查询语句。', + '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', + ], + ], + [ + 'name' => 'From', + 'in' => 'query', + 'schema' => [ + 'description' => '查询开始时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1668687302', + ], + ], + [ + 'name' => 'To', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间点。Unix时间戳类型，表示从1970-1-1 00:00:00 UTC计算起的秒数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1668688000', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Code' => [ + 'description' => '接口状态，取值说明如下：'."\n" + ."\n" + .'- 2XX：成功。'."\n" + .'- 3XX：重定向。'."\n" + .'- 4XX：请求错误。'."\n" + .'- 5XX：服务器错误。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '-', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '查询成功后返回的前端监控数据。', + '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" + .' }', + ], + ], + ], + ], + ], + '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' => '根据SLS查询语句获取前端监控数据', + ], + 'GetRetcodeAppByPid' => [ + 'summary' => '根据前端监控应用Pid返回前端监控应用对象。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用PID。在ARMS控制台的**前端监控**>**前端列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'example' => 'b590lhguqs@9781be0f44dXXXX', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键值对，当您未输入ResourceIds参数时必填。取值说明如下： key：标签键，字符长度范围[1,128]。 value：标签值，字符长度范围[1,128]。 区分大小写。如果指定多个标签，则会为指定资源同时创建并绑定多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。不能以aliyun和acs:开头，不能包含http://或者https://。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。必填参数，不允许为空字符串。最多支持128个字符，不能以```aliyun```和```acs:```开头，不能包含```http://```或 ```https://```。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。非必填，可以为空字符串。最多支持128个字符，不能以```acs:```开头，不能包含```http://```或者```https://```。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', + ], + 'RetcodeApp' => [ + 'description' => '前端监控应用返回数据。', + 'type' => 'object', + 'properties' => [ + 'AppName' => [ + 'description' => '前端监控应用名称。', + 'type' => 'string', + 'example' => 'testRetcodeAppXXXX', + ], + 'RetcodeAppType' => [ + 'description' => '前端监控应用类型，包括：'."\n" + ."\n" + .'- `web`：Web页面'."\n" + .'- `weex`：Weex页面'."\n" + .'- `mini_dd`：钉钉小程序'."\n" + .'- `mini_alipay`：支付宝小程序'."\n" + .'- `mini_wx`：微信小程序'."\n" + .'- `mini_common`：其他小程序', + 'type' => 'string', + 'example' => 'web', + ], + 'AppId' => [ + 'description' => '应用ID，数据库自增字段。', + 'type' => 'string', + 'example' => '2787XXXX', + ], + 'Pid' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'b590lhguqs@9781be0f44dXXXX', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'example' => 'rg-acfmxidtzXXXX', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'example' => 'testKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'example' => 'testValue', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '根据Pid获取前端监控应用', + ], + 'UpdateRumFileStatus' => [ + 'summary' => '更新RUM文件状态，上传RUM文件成功后，调用此接口。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'atc8xxxx'."\n" + .'cf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '文件唯一ID，不传系统将自动为您设置一个UUID。', + 'type' => 'string', + 'required' => false, + 'example' => 'MS4wLjAtbWFpbi4wZjM0NzRlOSxxxxxx', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.js.map', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '文件大小，单位：字节。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '文件状态，SUCCESS：成功，INIT：初始化。', + 'type' => 'string', + 'required' => false, + 'example' => 'SUCCESS', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => '626037F5-FDEB-45B0-804C-B3C92797****', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"626037F5-FDEB-45B0-804C-B3C92797****\\"\\n}","type":"json"}]', + 'title' => '更新RUM文件状态', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'GetRumUploadFiles' => [ + 'summary' => '获取RUM相关文件，包括符号表、SourceMap等。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件类型，source-map：SourceMap文件，mapping：安卓符号表文件，dsym：iOS的dSYM文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'source-map', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'aoxxxxxly@741623b4e91****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件版本号，该字段不传值时默认返回所有版本的文件。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + ], + ], + [ + 'name' => 'NextToken', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '内部错误，请联系管理员。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '文件列表。', + 'type' => 'object', + 'properties' => [ + 'FileList' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'VersionId' => [ + 'type' => 'string', + ], + 'Uuid' => [ + 'type' => 'string', + ], + 'Size' => [ + 'type' => 'string', + ], + 'FileName' => [ + 'type' => 'string', + ], + 'LastModifiedTime' => [ + 'type' => 'any', + ], + ], + ], + ], + 'NextToken' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取RUM文件', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'GetRumDataForPage' => [ + 'summary' => '分页获取RUM数据。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197708', + 'abilityTreeNodes' => [ + 'FEATUREarmsH2Y9JL', + ], + ], + 'parameters' => [ + [ + 'name' => 'Query', + 'in' => 'query', + 'schema' => [ + 'description' => '符合SLS Logstore查询语法的查询语句，可参考前端界面此接口的传参。', + 'type' => 'string', + 'required' => true, + 'example' => '* and app.id: xxxx@586810fbxxxx19f '."\n", + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'iixxxjcnuk@582846f37******', + ], + ], + [ + 'name' => 'AppGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间的时间戳，精确到秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1713687833', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间的时间戳，精确到秒。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1713774233', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '每页的记录条数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的当前页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '内部错误，请联系管理员。'."\n", + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '数据总条数。', + 'type' => 'string', + 'example' => '7', + ], + 'Page' => [ + 'description' => '当前页。', + 'type' => 'string', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'string', + 'example' => '20', + ], + 'Authentication' => [ + 'description' => '保留字段，请忽略。', + 'type' => 'string', + 'example' => '保留字段，请忽略。', + ], + 'Completion' => [ + 'description' => '是否结束，true：已结束，false：未结束。', + 'type' => 'string', + 'example' => 'true', + ], + 'Preference' => [ + 'description' => '保留字段，请忽略。', + 'type' => 'string', + 'example' => '保留字段，请忽略。'."\n" + ."\n", + ], + 'Items' => [ + 'description' => '数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的数据详情，JSON Map格式。', + 'type' => 'object', + 'example' => '查询到的数据详情，JSON Map格式。'."\n" + ."\n", + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '分页获取RUM数据', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'CreateRumUploadFileUrl' => [ + 'summary' => '用于上传SourceMap文件、符号表文件等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'iioe7jcnuk@582846f37******', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '文件唯一ID。', + 'type' => 'string', + 'required' => false, + 'example' => '125bdb39-a415-4503-bd96-e293925fc64c', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名称', + 'type' => 'string', + 'required' => true, + 'example' => 'test.js.map', + ], + ], + [ + 'name' => 'ContentType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件类型，可传`"application/zip"`、`"text/plain"`，或空字符串。', + 'type' => 'string', + 'required' => false, + 'example' => 'text/plain', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'SourcemapType', + 'in' => 'query', + 'schema' => [ + 'description' => '文件类型：'."\n" + ."\n" + .'- source-map：SourceMap文件'."\n" + .'- mapping：安卓符号表文件'."\n" + .'- dsym：iOS的dSYM文件', + 'type' => 'string', + 'required' => false, + 'example' => 'source-map', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '内部错误，请联系管理员。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '文件上传链接。', + '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', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '创建RUM文件上传链接', + 'description' => '此接口的返回值是一个文件上传链接，用户可通过该文件上传链接上传文件，使用方式可参考文档：[使用URL上传文件](~~2579659~~)', + ], + 'DeleteRumUploadFile' => [ + 'summary' => '用于删除符号表、SourceMap等文件。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'VersionId', + 'in' => 'query', + 'schema' => [ + 'description' => '文件版本号。', + 'type' => 'string', + 'required' => false, + 'example' => '1.0.0', + ], + ], + [ + 'name' => 'Uuid', + 'in' => 'query', + 'schema' => [ + 'description' => '文件唯一ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'MS4wLjAtbWFpbi4wZjM0NzRlOSxxxxxx', + ], + ], + [ + 'name' => 'FileName', + 'in' => 'query', + 'schema' => [ + 'description' => '文件名，带扩展名。', + 'type' => 'string', + 'required' => false, + 'example' => 'test.js.map', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'BatchItems', + 'in' => 'query', + 'schema' => [ + 'description' => '批量删除参数，JSON 数组格式。如果需要删除单个文件时，该字段不填，如果需要批量删除文件时，仅需填该字段。', + '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" + .' }]', + ], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '内部错误，请联系管理员。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否删除成功，删除成功返回success。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '删除RUM文件', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'GetRumAppInfo' => [ + 'summary' => '获取前端监控单个应用信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '197299', + 'abilityTreeNodes' => [ + 'FEATUREarmsRY7LT8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'AppGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'Code' => [ + 'description' => '状态码。返回200代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功。'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '内部错误，请联系管理员。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '应用详情。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '创建时间，单位是毫秒时间戳。', + 'type' => 'string', + 'example' => '1683353594000', + ], + 'Name' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => 'tomcat-demo-test', + ], + 'Pid' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'avccccefy0@24cccccbf384dc6', + ], + 'Type' => [ + 'description' => '应用类型，此字段为固定值RUM。', + 'type' => 'string', + 'example' => 'RUM', + ], + 'NickName' => [ + 'description' => '应用别名。', + 'type' => 'string', + 'example' => 'nickname', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AppType' => [ + 'description' => '应用类型，Web&H5：web，小程序：miniapp，iOS：ios，Android：android。', + 'type' => 'string', + 'example' => 'web', + ], + 'Status' => [ + 'description' => '应用状态，created：已创建，running：运行中，stopped：停止数据上报。', + 'type' => 'string', + 'example' => 'running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2vezare****', + ], + 'IsSubscription' => [ + 'description' => '是否收藏，true：收藏，false：未收藏。', + 'type' => 'string', + 'example' => 'true', + ], + 'Description' => [ + 'description' => '应用描述信息。', + 'type' => 'string', + 'example' => '门户首页。', + ], + 'PackageName' => [ + 'description' => '应用程序包名', + 'type' => 'string', + 'example' => 'com.alibaba.rum', + ], + 'Endpoint' => [ + 'description' => '应用数据的上报endpoint。', + 'type' => 'string', + 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', + ], + 'SlsProject' => [ + 'description' => '存储应用数据的SLS Project名称。', + 'type' => 'string', + 'example' => 'proj-xtrace-xxxxxxxxxxxxxxxxxxxxxxx-cn-hangzhou', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的键。', + 'type' => 'string', + 'example' => 'Label', + ], + 'Value' => [ + 'description' => 'Tag的值', + 'type' => 'string', + 'example' => 'Value', + ], + ], + ], + ], + 'SlsLogstore' => [ + 'description' => '存储应用数据的SLS Logstore名称。', + 'type' => 'string', + 'example' => 'logstore-rum', + ], + 'ServiceDomainConfigs' => [ + 'description' => '服务域名配置列表（当前仅支持移动端应用）', + 'type' => 'array', + 'items' => [ + 'description' => '服务域名配置', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名或IP', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '测试', + ], + 'Tracing' => [ + 'description' => '是否启用链路追踪（需要开通可观测链路OpenTelemetry版），取值：'."\n" + ."\n" + .'- `true`：启用链路追踪（开启后，将会在该域名请求中插入相关Header）。'."\n" + ."\n" + .'- `false`：不启用链路追踪。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'PropagatorTypes' => [ + 'description' => 'Trace透传协议列表，开启链路追踪时必传', + 'type' => 'array', + 'items' => [ + 'description' => 'Trace透传协议，当前仅支持Skywalking V2、V3，分别对应：sw6、sw8', + 'type' => 'string', + 'example' => 'sw8', + ], + ], + 'SamplingRate' => [ + 'description' => 'Trace采样率：(0, 100]', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + ], + ], + ], + 'CdnDomain' => [ + 'description' => 'SDK域名。', + 'type' => 'string', + 'example' => 'b59xxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js', + ], + 'BonreeSDKConfig' => [ + 'description' => '移动端采集配置', + 'type' => 'object', + 'properties' => [ + 'moduleConfig' => [ + 'description' => '模块功能开关', + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'description' => '总开关', + 'type' => 'boolean', + 'example' => 'true', + ], + 'defaultConfig' => [ + 'description' => '应用默认配置', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'type' => 'boolean', + 'description' => '开关', + 'example' => 'true', + ], + ], + 'description' => '模块配置项', + ], + ], + 'versionConfigs' => [ + 'description' => '应用版本配置', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'useCustom' => [ + 'type' => 'boolean', + 'example' => 'true', + 'description' => '是否使用自定义配置', + ], + 'customConfig' => [ + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'object', + 'properties' => [ + 'enable' => [ + 'type' => 'boolean', + 'description' => '开关', + 'example' => 'true', + ], + ], + 'description' => '模块配置项', + ], + 'description' => '自定义配置项', + ], + 'description' => [ + 'type' => 'string', + 'example' => '1.1.0版本配置', + 'description' => '版本配置描述', + ], + 'updateTime' => [ + 'type' => 'integer', + 'format' => 'int64', + 'description' => '版本配置更新时间', + 'example' => '1721112372055', + ], + ], + 'description' => '版本配置', + ], + ], + ], + ], + 'samplingConfig' => [ + 'description' => '采样配置', + 'type' => 'object', + 'properties' => [ + 'samplingType' => [ + 'description' => '采样类型，当前仅支持session随机采样，即固定传：1', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'samplingRate' => [ + 'description' => '采样率：(0, 1000] 之间，千分比', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '500', + ], + ], + ], + ], + ], + 'AppGroup' => [ + 'description' => '应用分组。', + 'type' => 'string', + 'example' => 'default', + ], + 'BackendServiceTraceRegion' => [ + 'description' => '后端应用部署区域（端到端链路场景使用）', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AppConfig' => [ + 'description' => '旧版应用配置，目前已废弃（JSON格式）', + 'type' => 'string', + 'example' => '{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}', + ], + 'WebSDKConfigJson' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取RUM应用信息', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'GetRumApps' => [ + 'summary' => '获取RUM应用列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194710', + 'abilityTreeNodes' => [ + 'FEATUREarmsRY7LT8', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'b590lhguqs@28f515462******', + ], + ], + [ + 'name' => 'AppGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称，仅支持传单个名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => [ + 'description' => '应用类型，目前支持：web、miniapp、android、ios、Windows、macOS、harmonyos等类型', + 'type' => 'string', + 'required' => false, + 'example' => 'web', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + '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' => '70675725-8F11-4817-8106-CFE0AD71****', + ], + 'Code' => [ + 'description' => '状态码。返回200代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '内部错误，请联系客服。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'AppList' => [ + 'description' => '应用列表。', + 'type' => 'array', + 'items' => [ + 'description' => '应用详情。', + 'type' => 'object', + 'properties' => [ + 'CreateTime' => [ + 'description' => '创建时间的时间戳', + 'type' => 'any', + 'example' => '1685686960872', + ], + 'Name' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'example' => '门户首页。', + ], + 'Pid' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'xxxxx@cc08bdxxxx20b15', + ], + 'Type' => [ + 'description' => '应用类型，此字段为固定值RUM。', + 'type' => 'string', + 'example' => 'RUM', + ], + 'NickName' => [ + 'description' => '应用别名。', + 'type' => 'string', + 'example' => 'Williamtag', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AppType' => [ + 'description' => '应用类型，web：Web&H5，miniapp：小程序，ios：iOS，android：Android。', + 'type' => 'string', + 'example' => 'web', + ], + 'Status' => [ + 'description' => '应用状态，created：已创建，running：运行中，stopped：停止数据上报。', + 'type' => 'string', + 'example' => 'running', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-acfmzaq3ypaqkdy', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。最多支持128个字符，不能以aliyun或acs:开头，不能包含http://或https://。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + 'IsSubscription' => [ + 'description' => '是否收藏，true：收藏，false：未收藏。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Description' => [ + 'description' => '应用描述信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'PackageName' => [ + 'description' => 'Android应用的包名。', + 'type' => 'string', + 'example' => 'com.zy.yxws', + ], + 'Endpoint' => [ + 'description' => '应用数据的上报endpoint。', + 'type' => 'string', + 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', + ], + 'SlsProject' => [ + 'description' => '存储应用数据的SLS Project名称。', + 'type' => 'string', + 'example' => 'proj-xtrace-xxxxxxxba6ef5466b5debf9e2f951-cn-hangzhou', + ], + 'SlsLogstore' => [ + 'description' => '存储应用数据的SLS Logstore名称。', + 'type' => 'string', + 'example' => 'logstore-rum', + ], + 'ServiceDomainConfigs' => [ + 'description' => '服务域名配置列表（当前仅支持移动端应用）', + 'type' => 'array', + 'items' => [ + 'description' => '服务域名配置', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名或IP', + 'type' => 'string', + 'example' => 'example.com', + ], + 'Description' => [ + 'description' => '描述', + 'type' => 'string', + 'example' => '测试', + ], + 'Tracing' => [ + 'description' => '是否启用链路追踪（需要开通可观测链路OpenTelemetry版），取值：'."\n" + ."\n" + .'- `true`：启用链路追踪（开启后，将会在该域名请求中插入相关Header）。'."\n" + ."\n" + .'- `false`：不启用链路追踪。', + 'type' => 'string', + 'example' => 'true', + ], + 'PropagatorTypes' => [ + 'description' => 'Trace透传协议列表，开启链路追踪时必传', + 'type' => 'array', + 'items' => [ + 'description' => 'Trace透传协议，当前仅支持Skywalking V2、V3，分别对应：sw6、sw8', + 'type' => 'string', + 'example' => 'sw8', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取RUM应用列表', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'CreateRumApp' => [ + 'summary' => '创建RUM应用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194698', + 'abilityTreeNodes' => [ + 'FEATUREarmsRY7LT8', + ], + ], + 'parameters' => [ + [ + 'name' => 'AppName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'SiteType', + 'in' => 'query', + 'schema' => [ + 'description' => '应用类型，Web&H5：web，小程序：miniapp，iOS：ios，Android：android。', + 'type' => 'string', + 'required' => true, + 'example' => 'web', + ], + ], + [ + 'name' => 'Source', + 'in' => 'query', + 'schema' => [ + 'description' => '来源，保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms', + ], + ], + [ + 'name' => 'AppGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '应用组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '应用描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => '用户体验监控前端', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表，最多20个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表，最多20个。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键', + 'type' => 'string', + 'required' => false, + 'example' => 'app', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'ecs', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'PackageName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Android 应用包名。创建Android应用时必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'com.xxxx.xxxxxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'NickName', + 'in' => 'query', + 'schema' => [ + 'description' => '应用昵称。', + 'type' => 'string', + 'required' => false, + 'example' => 'test-app', + ], + ], + [ + 'name' => 'RealRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用实际接入Region（仅上海金融云场景使用）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-finance-1', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '客户端语言', + 'type' => 'string', + 'required' => false, + 'example' => 'java', + ], + ], + ], + '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' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', + ], + 'Code' => [ + 'description' => '接口状态码：2XX：成功 3XX：重定向 4XX：请求错误 5XX：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否成功发起调用：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'title' => 'Id of the request', + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '应用已存在。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '创建成功时，返回应用id和上报域名，用英文逗号隔开。', + 'type' => 'object', + 'properties' => [ + 'Pid' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'avccccxxxx@24cxxxxbf384dc6', + ], + 'Endpoint' => [ + 'description' => '应用数据的上报endpoint。', + 'type' => 'string', + 'example' => 'xxxxxxxx-default-cn.rum.aliyuncs.com', + ], + 'CdnDomain' => [ + 'description' => 'SDK域名。', + 'type' => 'string', + 'example' => 'bxxxxxxx-sdk.rum.aliyuncs.com/v2/browser-sdk.js', + ], + ], + 'example' => 'ggxxxnjuz@xxxx,xxxxxx-default-cn.rum.aliyuncs.com', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + ], + ], + ], + ], + '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' => '创建RUM应用', + ], + 'DeleteRumApp' => [ + 'summary' => '删除RUM应用。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'b590lhguqs@28f515462******', + ], + ], + [ + 'name' => 'AppGroup', + 'in' => 'query', + 'schema' => [ + 'description' => '应用分组。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'RealRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用实际接入Region（仅上海金融云场景使用）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-finance-1', + ], + ], + ], + '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' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '删除是否成功，成功：true，失败：false.', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '错误提示信息。', + 'type' => 'string', + 'example' => '删除的应用不存在。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Result' => [ + 'description' => '删除结果提示。', + 'type' => 'string', + 'example' => '删除应用成功。', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2eq4peca****', + ], + ], + ], + ], + ], + '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' => '删除RUM应用', + ], + 'UpdateRumApp' => [ + 'summary' => '更新RUM应用。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '211832', + 'abilityTreeNodes' => [ + 'FEATUREarmsRY7LT8', + ], + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'b5xxxxs@d8deedfa9bf****', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '应用描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'IsSubscribe', + 'in' => 'query', + 'schema' => [ + 'description' => '是否收藏，true：收藏，false：不收藏。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Nickname', + 'in' => 'query', + 'schema' => [ + 'description' => '应用别名。', + 'type' => 'string', + 'required' => false, + 'example' => '应用别名。', + ], + ], + [ + 'name' => 'Restart', + 'in' => 'query', + 'schema' => [ + 'description' => '是否重启应用，true：重启，false：不重启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Stop', + 'in' => 'query', + 'schema' => [ + 'description' => '是否停止应用，true：停止，false：不停止。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'AutoRestart', + 'in' => 'query', + 'schema' => [ + 'description' => '是否第二天重启应用，true：重启，false：不重启。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ServiceDomainOperationJson', + 'in' => 'query', + 'schema' => [ + 'description' => '设置应用服务域名，支持创建、修改、删除服务域名配置', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"Op\\":\\"Update\\",\\"Domain\\":\\"example.com\\",\\"Config\\":{\\"Description\\":\\"这是描述bbb\\",\\"Tracing\\":\\"true\\",\\"PropagatorTypes\\":[\\"sw8\\"]}}', + ], + ], + [ + 'name' => 'BonreeSDKConfigJson', + 'in' => 'query', + 'schema' => [ + 'description' => '设置移动端SDK采集配置，支持按APP版本开启或关闭采集项', + '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\\":{}}}}}', + ], + ], + [ + 'name' => 'RealRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用实际接入Region（仅上海金融云场景使用）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shanghai-finance-1', + ], + ], + [ + 'name' => 'BackendServiceTraceRegion', + 'in' => 'query', + 'schema' => [ + 'description' => '后端应用部署区域（端到端链路场景使用）', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppConfig', + 'in' => 'query', + 'schema' => [ + 'description' => '旧版应用配置（JSON格式），目前已废弃', + 'type' => 'string', + 'required' => false, + 'example' => '{"apiRequestOfH5":300,"apiRequestOfOriginal":500,"coldStart":5000,"hotStart":3000,"staticResourceLoad":300,"stutter":1000,"viewLoadOfH5":1000,"viewLoadOfOriginal":2000}', + ], + ], + [ + 'name' => 'WebSDKConfigJson', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '更新是否成功。'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果详情。', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => '用户配置，保留字段。', + 'type' => 'string', + 'example' => '用户配置，保留字段。', + ], + 'Usage' => [ + 'description' => '用量，单位字节数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10000', + ], + 'Limit' => [ + 'description' => '限额，单位字节数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100000', + ], + 'Limited' => [ + 'description' => '是否被限额，true：是，false：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '更新RUM应用', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'GetRumExceptionStack' => [ + 'summary' => '获取RUM异常堆栈信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '213079', + 'abilityTreeNodes' => [ + 'FEATUREarms46ES94', + ], + ], + 'parameters' => [ + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'atxxxxzkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'ExceptionStack', + 'in' => 'query', + 'schema' => [ + 'description' => '错误堆栈信息，JSON列表格式，列表元素包括call_stack.info、call_stack.thread.name和call_stack.thread.id三个字段，分别代表堆栈信息、线程名称和线程id，同SLS的logstore-rum中的exception.stack字段完全一致。', + '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" + .']', + ], + ], + [ + 'name' => 'ExceptionBinaryImages', + 'in' => 'query', + 'schema' => [ + 'description' => 'Binary Images，表示在崩溃时装载到进程地址空间的所有可执行文件。', + 'type' => 'string', + 'required' => false, + 'example' => 'iOSDemo:arm64%3B1489F4D3-6DE2-300C-90E9-E1B869675351%3B0x0000000104064000\\nAlibabaCloudRUM:arm64%3BAB7B3A8E-6CEE-325D-BCBB-8DA50E61804F%3B0x0000000106660000\\nlibdispatch.dylib:arm', + ], + ], + [ + 'name' => 'ExceptionThreadId', + 'in' => 'query', + 'schema' => [ + 'description' => '异常线程ID。', + 'type' => 'string', + 'required' => false, + 'example' => '16643', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SourcemapType', + 'in' => 'query', + 'schema' => [ + 'description' => '指定解析类型'."\n" + .'- js：JS 错误解析'."\n" + .'- sym：PC 端解析'."\n" + .'- har：鸿蒙端解析'."\n" + .'- dSYM： iOS 端解析'."\n" + .'- so: 安卓端解析', + 'type' => 'string', + 'required' => false, + 'example' => 'js', + ], + ], + [ + 'name' => 'ExtraInfo', + 'in' => 'query', + 'schema' => [ + 'description' => '在 iOS 端解析额外的系统符号表信息，用户可不填', + 'type' => 'string', + 'required' => false, + 'example' => 'GraphicsServices:system/GraphicsServices/85419099-269B-336D-86B4-0D52D0FF6923/GraphicsServices;WebCore:system/WebCore/BF44A3F4-85D4-38C8-BF26-197F06ADE273/WebCore', + ], + ], + [ + 'name' => 'Workspace', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + [ + 'name' => 'ServiceId', + 'in' => 'query', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否执行成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'string', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '内部错误，请联系管理员。', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码。', + 'type' => 'string', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果信息。', + 'type' => 'object', + 'properties' => [ + 'ThreadId' => [ + 'description' => '线程ID。', + 'type' => 'string', + 'example' => '16643', + ], + 'Lines' => [ + 'description' => '堆栈列表。', + 'type' => 'array', + 'items' => [ + 'description' => '解析后的错误堆栈信息。', + 'type' => 'string', + 'example' => '"CoreFoundation 0x00000001aa66a678 0x00000001aa57e000 + 968312",'."\n" + .' "libobjc.A.dylib 0x00000001a2917c80 0x00000001a28ec000 + 179328"', + ], + ], + 'CrashReason' => [ + 'description' => 'PC端解析时会透出，异常原因', + 'type' => 'string', + 'example' => 'EXC_BAD_ACCESS / KERN_INVALID_ADDRESS', + ], + 'CrashAddress' => [ + 'description' => 'PC端解析时会透出，崩溃地址', + 'type' => 'string', + 'example' => '0x1', + ], + 'ThreadInfoList' => [ + 'description' => 'PC 端崩溃，抓取的线程堆栈详情', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ThreadTag' => [ + 'description' => '线程标签（包含线程号和线程名）', + 'type' => 'string', + 'example' => 'Thread 0 (crashed)', + ], + 'ThreadDetail' => [ + 'description' => '详细的线程堆栈', + '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", + ], + ], + ], + ], + 'ModuleName' => [ + 'description' => 'PC 端解析时会透出，崩溃解析模块名', + 'type' => 'string', + 'example' => 'alibabacloud_rum_example', + ], + 'Uuid' => [ + 'description' => 'PC 端解析会透出，解析堆栈所需符号表的 UUID', + 'type' => 'string', + 'example' => '9032259CEB9130E780C6DE8FDECCD7990', + ], + 'BinaryImages' => [ + 'description' => 'PC 端解析会透出，解析异常堆栈所需的系统符号表的名字与 UUID', + '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"', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取RUM异常堆栈信息', + 'description' => '用户体验监控目前仅在杭州、新加坡、硅谷提供服务，请选择正确的Endpoint。', + ], + 'DescribeEnvDropMetricsRule' => [ + 'summary' => '查询指定环境实例的废弃指标列表', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxxx', + ], + ], + ], + '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' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RuleName' => [ + 'title' => '废弃指标规则名', + 'description' => '废弃指标规则名', + 'type' => 'string', + 'example' => 'ruleName1', + ], + 'DropMetrics' => [ + 'title' => '废弃指标列表。多个指标之间，以换行分隔。', + 'description' => '废弃指标列表。多个指标之间，以换行分隔。', + 'type' => 'string', + 'example' => 'kube_pod_created', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '查询接入环境的废弃指标规则', + ], + 'UpdateEnvDropMetricsRule' => [ + 'summary' => '更新环境中废弃指标规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'DropMetrics', + 'in' => 'formData', + 'schema' => [ + 'title' => '多个指标之间，以换行分隔', + 'description' => '要废弃的指标，多个指标之间以换行分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'metric_1'."\n" + .'metric_2'."\n" + .'metric_3', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'The request ID.', + 'type' => 'string', + 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果', + 'description' => '操作结果。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '更新环境中废弃指标规则', + ], + 'AddTagToFlinkCluster' => [ + 'summary' => '主要将用户Flink工作空间对应的Prometheus实例打上工作空间ID、工作空间名称这两个Tag。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => 'prometheus实例ID', + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c5defa51f******c92bd2ef5fb093269', + ], + ], + [ + 'name' => 'TargetUserId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flink工作空间隶属的主账号ID。', + 'type' => 'string', + 'required' => true, + 'example' => '198608******7619', + ], + ], + [ + 'name' => 'FlinkWorkSpaceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flink工作空间ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ab18f***93744d', + ], + ], + [ + 'name' => 'FlinkWorkSpaceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Flink工作空间名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'flink-demo', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + ], + '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' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', + ], + 'Success' => [ + 'description' => '是否成功发起调用：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '是否成功执行业务逻辑：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'string', + 'example' => 'false', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"2FC13182-B9AF-4E6B-BE51-72669B7C****\\",\\n \\"Success\\": true,\\n \\"Code\\": 200,\\n \\"Data\\": \\"false\\"\\n}","type":"json"}]', + 'title' => 'Prometheus Flink集群打标', + ], + 'CreateEnvironment' => [ + 'summary' => '创建环境实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentName', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => '环境名称', + 'description' => '环境名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'env1', + ], + ], + [ + 'name' => 'EnvironmentType', + 'in' => 'query', + 'schema' => [ + 'title' => '环境类型：'."\n" + .'CS（容器服务）、ECS、Cloud（云服务）', + 'description' => '环境类型：'."\n" + .'- CS：容器服务。'."\n" + .'- ECS：ECS。'."\n" + .'- Cloud：云服务。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'CS', + 'enum' => [ + 'CS', + 'ECS', + 'Cloud', + ], + ], + ], + [ + 'name' => 'EnvironmentSubType', + 'in' => 'query', + 'schema' => [ + 'title' => 'ECS、ACK、Cloud、One', + 'description' => '环境的子类型：'."\n" + .'- CS类型的环境：目前支持ACK、One子类型。'."\n" + .'- ECS类型的环境：目前支持ECS子类型。'."\n" + .'- Cloud类型的环境：目前支持Cloud子类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ECS' => 'ECS', + 'Cloud' => 'Cloud', + 'One' => 'One', + 'ACK' => 'ACK', + ], + 'example' => 'ECS、ACK等。', + 'enum' => [], + ], + ], + [ + 'name' => 'BindResourceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '环境绑定的资源实例ID。如果是Cloud（云服务），则填写RegionId。', + 'description' => '环境绑定的资源实例ID，包括容器实例ID或VpcId。'."\n" + .'对于Cloud类型的环境，当前字段值为RegionId。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'c6e9dec475dca4a50a188411d8cbxxx', + ], + ], + [ + 'name' => 'ManagedType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', + 'description' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exporter： 托管agent和exporter。云服务类型的默认值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'none', + 'enum' => [ + 'none', + 'agent', + 'agent-exporter', + ], + ], + ], + [ + 'name' => 'FeePackage', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，请输入空值。', + 'description' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，请输入空值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'CS_Basic', + 'enum' => [ + 'CS_Basic', + 'CS_Pro', + ], + ], + ], + [ + 'name' => 'PrometheusInstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '可空，环境绑定的prom实例id。如果未提供，请调用 InitEnvironment 接口完成存储实例的初始化。', + 'description' => '可空，环境绑定的prom实例id。如果未提供，请调用 InitEnvironment 接口完成存储实例的初始化。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'c6e9dec475dca4a50a188411d8cbxxx', + 'enum' => [], + ], + ], + [ + 'name' => 'GrafanaWorkspaceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '环境绑定的grafana工作区id。传空时，表示使用默认的共享grafana。', + 'description' => '环境绑定的grafana工作区id。传空时，表示使用默认的共享grafana。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'grafana-rnglkcdrntlhk0****', + 'enum' => [], + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '资源组Id', + 'description' => '资源组Id。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'rg-acfmxyexli2****', + 'enum' => [], + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '可以传此参数，给实例创建标签进行管理', + 'description' => '可以传此参数，给实例创建标签进行管理。', + '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, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'InitEnvironment', + 'in' => 'query', + 'schema' => [ + 'title' => '是否初始化环境', + 'description' => '是否初始化环境', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '返回成功增加的环境Id。', + 'description' => '返回成功增加的环境Id。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"env-xxxxx\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + 'title' => '创建环境', + ], + 'InitEnvironment' => [ + 'summary' => '初始化环境实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境：'."\n" + ."\n" + .'- zh（默认）：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'ManagedType', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', + 'description' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'agent', + 'enum' => [ + 'none', + 'agent', + 'agent-exporter', + ], + ], + ], + [ + 'name' => 'CreateAuthToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否创建Token，以提升数据读取安全性。', + 'description' => '是否创建Token，以提升数据读取安全性。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果', + 'description' => '操作结果', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '初始化环境实例', + ], + 'DescribeEnvironment' => [ + 'summary' => '查询环境详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + ], + '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' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'EnvironmentType' => [ + 'description' => '环境类型：'."\n" + .'- CS：容器服务。'."\n" + .'- ECS。'."\n" + .'- Cloud：云服务。', + 'type' => 'string', + 'example' => 'CS', + ], + 'EnvironmentName' => [ + 'description' => '环境名称。', + 'type' => 'string', + 'example' => 'env1', + ], + 'EnvironmentSubType' => [ + 'description' => '环境的子类型：'."\n" + .'- CS：目前支持ACK。'."\n" + .'- ECS：目前支持ECS。'."\n" + .'- Cloud：目前支持Cloud。', + 'type' => 'string', + 'example' => 'ACK', + ], + 'RegionId' => [ + 'description' => '地域id', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'UserId' => [ + 'description' => '用户Id。', + 'type' => 'string', + 'example' => '13002222xxxx', + ], + 'BindResourceId' => [ + 'description' => '环境绑定的资源实例ID，包括容器实例ID 或 VpcId。', + 'type' => 'string', + 'example' => 'vpc-xxxxx', + ], + 'BindResourceType' => [ + 'description' => '绑定的资源类型。', + 'type' => 'string', + 'example' => 'ECS', + ], + 'BindResourceStatus' => [ + 'description' => '绑定资源的状态。', + 'type' => 'string', + 'example' => 'running', + ], + 'BindResourceProfile' => [ + 'description' => '绑定资源的Profile。', + 'type' => 'string', + 'example' => 'Default', + ], + 'BindVpcCidr' => [ + 'description' => '绑定vpc的网段。', + 'type' => 'string', + 'example' => '192.168.0.0/16', + ], + 'PrometheusInstanceId' => [ + 'title' => '绑定的prometheus实例ID', + 'description' => '绑定的prometheus实例ID。', + 'type' => 'string', + 'example' => 'xxxxyyyyyzzzzz', + ], + 'PrometheusInstanceName' => [ + 'title' => '绑定的prometheus实例名称', + 'description' => '绑定的prometheus实例名称。', + 'type' => 'string', + 'example' => 'name1', + ], + 'GrafanaWorkspaceId' => [ + 'title' => 'grafana工作区id', + 'description' => 'grafana工作区id', + 'type' => 'string', + 'example' => 'grafana-cn-i7m2qn9xa01', + ], + 'GrafanaFolderUid' => [ + 'description' => 'Grafana目录唯一ID。', + 'type' => 'string', + 'example' => 'xyz', + ], + 'GrafanaDatasourceUid' => [ + 'description' => 'Grafana数据源唯一ID。', + 'type' => 'string', + 'example' => 'zuvw', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-8vb02uk57qbcktqcvqqqj', + ], + 'GrafanaFolderUrl' => [ + 'description' => 'Grafana目录URL。', + 'type' => 'string', + 'example' => 'https://g.console.aliyun.com/dashboards/f/xxx/yyyy', + ], + 'BindResourceStoreDuration' => [ + 'title' => '单位 天', + 'description' => '绑定资源的保存时长(天)。', + 'type' => 'string', + 'example' => '15', + ], + 'GrafaDataSourceName' => [ + 'title' => '', + 'description' => 'Grafana数据源名称。', + 'type' => 'string', + 'example' => 'datasource1', + ], + 'GrafanaFolderTitle' => [ + 'title' => '', + 'description' => 'Grafana目录名。', + 'type' => 'string', + 'example' => 'folder1', + ], + 'ManagedType' => [ + 'title' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', + 'description' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', + 'type' => 'string', + 'enumValueTitles' => [ + 'agent' => '托管agent', + 'agent-exporter' => '托管agent和exporter', + 'none' => '非托管', + ], + 'example' => 'none', + ], + 'FeePackage' => [ + 'title' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可选为CS_Basic或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，为空值。', + 'description' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可选为CS_Basic或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，为空值。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CS_Pro' => '容器监控Pro版', + 'CS_Basic' => '容器监控基础版', + ], + 'example' => 'CS_Basic', + ], + 'DbInstanceStatus' => [ + 'title' => '绑定的prometheus实例db状态。', + 'description' => '绑定prometheus实例的db状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'UNINSTALLING' => 'UNINSTALLING', + 'INSTALLING' => 'INSTALLING', + 'UNINSTALLED' => 'UNINSTALLED', + 'RUNNING' => 'RUNNING', + 'MODIFYING' => 'MODIFYING', + ], + 'example' => 'RUNNING', + ], + 'SecurityGroupId' => [ + 'title' => '环境绑定的安全组Id', + 'description' => '环境绑定的安全组Id', + 'type' => 'string', + 'example' => 'sg-8vbdgmf4nraiqa9bx0jo', + ], + 'VswitchId' => [ + 'title' => '环境绑定的交换机Id', + 'description' => '环境绑定的交换机Id', + 'type' => 'string', + 'example' => 'vsw-2ze7yr3f1x8snryaioo7u', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-aek2vezare****', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的键。', + 'type' => 'string', + 'example' => 'user1', + ], + 'Value' => [ + 'description' => 'Tag的值', + 'type' => 'string', + 'example' => 'p_运维', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询环境详情', + ], + 'UpdateEnvironment' => [ + 'summary' => '更新环境信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'EnvironmentName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '环境名称', + 'description' => '环境名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'env1', + ], + ], + [ + 'name' => 'FeePackage', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，请输入空值。', + 'description' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，请输入空值。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'CS_Basic', + 'enum' => [ + 'CS_Basic', + 'CS_Pro', + ], + ], + ], + ], + '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' => '70675725-8F11-4817-8106-CFE0AD71****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果', + 'description' => '操作结果。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"70675725-8F11-4817-8106-CFE0AD71****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + 'title' => '更新环境信息', + ], + 'ListEnvironments' => [ + 'summary' => '查询环境列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '190992', + 'abilityTreeNodes' => [ + 'FEATUREarmsC7S24K', + ], + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentType', + 'in' => 'query', + 'schema' => [ + 'title' => '环境类型 CS(容器) | ECS. addonName和environmentType至少填一个', + 'description' => '环境类型， AddonName和EnvironmentType至少填一个。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CS' => '容器服务', + 'ECS' => 'ECS服务', + 'Cloud' => '云服务', + ], + 'example' => 'CS', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '非必填, regionId', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon的名称, addonName和environmentType至少填一个', + 'description' => 'Addon的名称，AddonName和EnvironmentType至少填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'trace-java', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aekzfurdatohtka', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'env', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'gfn_web_outbound_add', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'BindResourceId', + 'in' => 'query', + 'schema' => [ + 'title' => '绑定的资源ID。', + 'description' => '绑定的资源ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cb9229c48e41144dc96af190841808cb0', + ], + ], + [ + 'name' => 'FeePackage', + 'in' => 'query', + 'schema' => [ + 'description' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可以指定为CS_Basic（默认值）或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，请输入空值。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'CS_Pro' => '容器监控Pro版', + 'CS_Basic' => '容器监控基础版', + ], + 'example' => 'CS_Pro', + ], + ], + [ + 'name' => 'FilterRegionIds', + 'in' => 'query', + 'schema' => [ + 'title' => '指定Region查询。', + 'description' => '指定Region查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing,cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Environments' => [ + 'description' => '环境集合。', + 'type' => 'array', + 'items' => [ + 'description' => '环境集合。', + 'type' => 'object', + 'properties' => [ + 'Addons' => [ + 'description' => 'Addon集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'Addon详情。', + 'type' => 'object', + 'properties' => [ + 'Alias' => [ + 'description' => 'Addon别名。', + 'type' => 'string', + 'example' => 'Prometheus探针', + ], + 'Description' => [ + 'description' => 'Addon描述。', + 'type' => 'string', + 'example' => '以 Prometheus 采集规范采集 Metric 数据', + ], + 'Icon' => [ + 'description' => '图标地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + 'Name' => [ + 'description' => 'Addon名称。', + 'type' => 'string', + 'example' => 'metric-agent', + ], + ], + ], + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '13990957477389', + ], + 'BindResourceId' => [ + 'description' => '环境绑定的资源实例ID，包括容器实例ID 或 VPCID。', + 'type' => 'string', + 'example' => 'vpc-bp1bgo8ronn', + ], + 'BindResourceProfile' => [ + 'description' => '绑定资源的Profile。', + 'type' => 'string', + 'example' => 'xxx', + ], + 'BindResourceType' => [ + 'description' => '绑定的资源类型。', + 'type' => 'string', + 'example' => 'VPC', + ], + 'BindVpcCidr' => [ + 'description' => '绑定VPC的网段。', + 'type' => 'string', + 'example' => '172.16.0.0/12', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-03-24 11:58:35 +0800', + ], + 'CreatedUserId' => [ + 'description' => '创建的用户ID。', + 'type' => 'string', + 'example' => '12378523784982', + ], + 'EnvironmentId' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'example' => 'env-xxx', + ], + 'EnvironmentName' => [ + 'description' => '环境名称。', + 'type' => 'string', + 'example' => 'feiliks-biz-prod-edas', + ], + 'EnvironmentType' => [ + 'description' => '环境类型：'."\n" + .'- CS：容器服务。'."\n" + .'- ECS。'."\n" + .'- Cloud：云服务。', + 'type' => 'string', + 'enumValueTitles' => [ + 'CS' => '容器服务', + 'ECS' => 'ECS', + 'Cloud' => '云服务', + ], + 'example' => 'CS', + ], + 'Features' => [ + 'description' => 'Feature列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Feature详情。', + 'type' => 'object', + 'properties' => [ + 'Alias' => [ + 'description' => 'Feature别名。', + 'type' => 'string', + 'example' => 'Prometheus 探针', + ], + 'Description' => [ + 'description' => 'Feature描述。', + 'type' => 'string', + 'example' => '以 Prometheus 采集规范采集 Metric 数据', + ], + 'Icon' => [ + 'description' => 'Feature图标地址。', + 'type' => 'string', + 'example' => 'http://xxx', + ], + 'Name' => [ + 'description' => 'Feature名称。', + 'type' => 'string', + 'example' => 'metirc-agent', + ], + ], + ], + ], + 'GrafanaFolderTitle' => [ + 'description' => 'Grafana目录名。', + 'type' => 'string', + 'example' => 'filepath', + ], + 'GrafanaFolderUid' => [ + 'description' => 'Grafana目录唯一ID。', + 'type' => 'string', + 'example' => '1798319482935', + ], + 'PrometheusId' => [ + 'description' => 'Prometheus的ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '124769812', + ], + 'PrometheusInstanceId' => [ + 'description' => '绑定的Prometheus实例ID。', + 'type' => 'string', + 'example' => 'vpc-m5e4alj2i24ndbn', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmvt3xpr5aema', + ], + 'Tags' => [ + 'description' => '环境资源标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键。', + 'type' => 'string', + 'example' => 'fpx-tag', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + ], + ], + ], + 'GrafanaDatasourceUid' => [ + 'description' => 'Grafana数据源唯一ID。', + 'type' => 'string', + 'example' => '12374890', + ], + 'ReleaseCount' => [ + 'description' => '已安装Addon的数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '122', + ], + 'LatestReleaseCreateTime' => [ + 'description' => '最后一次Addon创建的时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'ManagedType' => [ + 'description' => '托管类型：'."\n" + .'- none： 非托管。ACK集群的默认值。'."\n" + .'- agent：托管agent（含ksm）。ASK、ACS、AckOne集群的默认值。'."\n" + .'- agent-exproter： 托管agent和exporter。云服务类型的默认值。', + 'type' => 'string', + 'example' => 'agent', + ], + 'FeePackage' => [ + 'description' => '付费套餐。'."\n" + .'* EnvironmentType为CS时：可选为CS_Basic或CS_Pro。'."\n" + .'* EnvironmentType为其它值时，为空值。', + 'type' => 'string', + 'example' => 'CS_Pro', + ], + ], + ], + ], + 'Total' => [ + 'description' => '总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询环境列表', + ], + 'DeleteEnvironment' => [ + 'summary' => '删除环境实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'DeletePromInstance', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否级联删除prometheus实例。', + 'description' => '是否级联删除prometheus实例。', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果描述', + 'description' => '操作结果描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '删除环境', + ], + 'DescribeAddonMetrics' => [ + 'summary' => '查询指定Addon的指标详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon名称', + 'description' => 'Addon名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon版本号', + 'description' => 'Addon版本号', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.1', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境,默认为中文 zh | en', + 'description' => '语言环境，默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentType', + 'in' => 'query', + 'schema' => [ + 'title' => '环境', + 'description' => '环境。', + 'type' => 'string', + 'required' => false, + 'example' => 'CS', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'B6A00968-82A8-4F14-9D1B-B53827DB****', + ], + 'Code' => [ + 'title' => '状态码, 200为正常, 其他为异常', + 'description' => '状态码, 200为正常, 其他为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '提示消息', + 'description' => '提示消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'title' => '业务是否成功', + 'description' => '业务是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '指标信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标信息列表。', + 'type' => 'object', + 'properties' => [ + 'Group' => [ + 'description' => '指标组。', + 'type' => 'string', + 'example' => 'Common', + ], + 'Labels' => [ + 'description' => '指标标签。', + 'type' => 'array', + 'items' => [ + 'description' => '指标标签。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '标签说明。', + 'type' => 'string', + 'example' => '大小为PAGE_SIZE的B树页面被成功压缩的次数。'."\n", + ], + 'Key' => [ + 'description' => '标签的Key。', + 'type' => 'string', + 'example' => 'page_size', + ], + 'Source' => [ + 'description' => '标签的Source。', + 'type' => 'string', + 'example' => 'db', + ], + ], + ], + ], + 'Metrics' => [ + 'description' => '指标列表。', + 'type' => 'array', + 'items' => [ + 'description' => '指标列表。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '指标说明。', + 'type' => 'string', + 'example' => '大小为PAGE_SIZE的B树页面被成功压缩的次数。'."\n", + ], + 'Labels' => [ + 'description' => '指标标签集合。', + 'type' => 'array', + 'items' => [ + 'description' => '指标标签集合。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '标签说明。', + 'type' => 'string', + 'example' => 'PAGE_SIZE', + ], + 'Key' => [ + 'description' => '标签Key。', + 'type' => 'string', + 'example' => 'page_size', + ], + 'Source' => [ + 'description' => '标签源。', + 'type' => 'string', + 'example' => 'db', + ], + ], + ], + ], + 'Type' => [ + 'description' => '指标类型。', + 'type' => 'string', + 'example' => 'GAUGE', + ], + 'Unit' => [ + 'description' => '指标单位。', + 'type' => 'string', + 'example' => 'bytes', + ], + 'Metric' => [ + 'description' => '指标名称。', + 'type' => 'string', + 'example' => 'mysql_exporter_collector_duration_seconds', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询Addon指标信息', + ], + 'InstallEnvironmentFeature' => [ + 'summary' => '安装Feature。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'region id', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Feature的名称: app-agent-pilot,metric-agent,ebpf-agent,service-check', + 'description' => 'Feature的名称。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'app-agent-pilot' => 'app pilot探针', + 'metric-agent' => '指标采集探针', + ], + 'example' => 'metric-agent', + ], + ], + [ + 'name' => 'FeatureVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'Feature的版本信息', + 'description' => 'Feature的版本信息。', + 'type' => 'string', + 'required' => true, + 'example' => '1.1.17', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'schema' => [ + 'title' => '用于填充的values', + 'description' => 'Feature的元数据信息。', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"continuous\\":true,\\"dataRevision\\":2}', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境，默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Region', + 'in' => 'query', + 'schema' => [ + 'title' => 'region信息', + 'description' => 'Feature的Region信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-shenzhen', + ], + ], + ], + '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' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回ReleaseID。', + 'type' => 'string', + 'example' => '83FCC44C-A056-18AF-A902-7043E723F0D9', + ], + ], + ], + ], + ], + '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' => '安装Feature', + ], + 'DescribeEnvironmentFeature' => [ + 'summary' => '查询Feature详情。', + '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' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => 'region id', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => [ + 'title' => 'feature的名称', + 'description' => 'Feature的名称。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'app-agent-pilot' => 'App Pilot 探针', + 'arms-cmonitor' => 'ARMS CMonitor 探针', + 'metric-agent' => 'Prometheus 探针', + ], + 'example' => 'metric-agent', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言参数，en | zh。', + 'description' => '语言参数，en | zh。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '查询是否成功：true：成功。 false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Feature' => [ + 'description' => 'Feature安装信息。', + 'type' => 'object', + 'properties' => [ + 'Alias' => [ + 'description' => 'Feature别名。', + 'type' => 'string', + 'example' => 'Prometheus 探针', + ], + 'Config' => [ + 'description' => 'Feature配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{}', + 'description' => 'Feature配置信息。', + ], + ], + 'Description' => [ + 'description' => 'Feature描述。', + 'type' => 'string', + 'example' => '以 Prometheus 采集规范采集 Metric 数据。', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'Icon' => [ + 'description' => '图标地址。', + 'type' => 'string', + 'example' => 'http://xxx', + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'LatestVersion' => [ + 'description' => '最新版本号。', + 'type' => 'string', + 'example' => '1.1.17', + ], + 'Name' => [ + 'description' => 'Feature名称。', + 'type' => 'string', + 'example' => 'metric-agent', + ], + 'Status' => [ + 'description' => '安装状态。'."\n" + .'- Installing 正在安装'."\n" + .'- Success 安装成功'."\n" + .'- Failed 安装失败'."\n" + .'- UnInstall 已卸载或未安装'."\n" + .'- UnInstalling 正在卸载'."\n" + .'- UnInstallFailed 卸载失败', + 'type' => 'string', + 'enumValueTitles' => [ + 'UnInstall' => '未安装或已卸载', + 'Failed' => '安装失败', + 'Installing' => '正在安装', + 'UnInstallFailed' => '卸载失败', + 'Success' => '安装成功', + 'UnInstalling' => '正在卸载', + ], + 'example' => 'Success', + ], + 'Version' => [ + 'description' => '版本。', + 'type' => 'string', + 'example' => '1.1.17', + ], + 'Managed' => [ + 'description' => '是否为托管组件。', + 'type' => 'boolean', + ], + ], + ], + 'FeatureStatus' => [ + 'description' => 'Feature的运行状态。', + 'type' => 'object', + 'properties' => [ + 'FeatureContainers' => [ + 'description' => 'Feature的容器列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Feature的容器信息。', + 'type' => 'object', + 'properties' => [ + 'Args' => [ + 'description' => '容器参数。', + 'type' => 'array', + 'items' => [ + 'description' => '参数值。', + 'type' => 'string', + 'example' => '['."\n" + .' "--port=9335",'."\n" + .' "--yaml=/etc/config/prometheusDisk/prometheus.yaml",'."\n" + .' "--chartVersion=1.1.17"'."\n" + .' ]', + ], + ], + 'Image' => [ + 'description' => '容器镜像。', + 'type' => 'string', + 'example' => 'registry-cn-hangzhou-vpc.ack.aliyuncs.com/acs/arms-prometheus-agent:v4.0.0', + ], + 'Name' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'arms-prometheus-operator', + ], + ], + ], + ], + 'Name' => [ + 'description' => 'Feature的K8s资源名称。', + 'type' => 'string', + 'example' => 'arms-prometheus-ack-arms-prometheus', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'Status' => [ + 'description' => '运行状态。'."\n" + .'- Success 运行正常'."\n" + .'- Failed 运行异常'."\n" + .'- Not Found 未安装', + 'type' => 'string', + 'enumValueTitles' => [ + 'Failed' => '运行异常', + 'Not Found' => '未安装', + 'Success' => '运行正常', + ], + 'example' => 'Success', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-bp1gbhqh8b4dsgvopkry', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-uf6vc2e4ytv8vv05j3u09', + ], + 'BindResourceId' => [ + 'description' => '绑定的资源ID。', + 'type' => 'string', + 'example' => 'c013823b55e4b4d6bb6b6f28682bd38a7', + ], + 'Ips' => [ + 'description' => 'Pod的IP地址。', + 'type' => 'array', + 'items' => [ + 'description' => '对应的IP。', + 'type' => 'string', + 'example' => '10.178.176.187', + ], + ], + ], + ], + 'config' => [ + 'description' => 'Feature的配置信息。', + 'type' => 'string', + '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' => '查询Feature详情', + 'requestParamsDescription' => 'FeatureName可通过[**ListEnvironmentFeatures**](~~2618314~~)查询可安装的Feature信息。', + ], + 'UpgradeEnvironmentFeature' => [ + 'summary' => '更新Feature信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => [ + 'title' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', + 'description' => 'Feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check。', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-agent', + ], + ], + [ + 'name' => 'FeatureVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'feature的版本', + 'description' => 'Feature的版本。', + 'type' => 'string', + 'required' => false, + 'example' => '1.1.17', + ], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'schema' => [ + 'title' => '开关服务发现用, PodAnnotation | PodMonitor | ServiceMonitor, PodAnnotation开关是run和mini, pm和sm则传 true和false, 例如 {"PodAnnotation":"run"}', + 'description' => '开关服务发现用, PodAnnotation | PodMonitor | ServiceMonitor, PodAnnotation开关是run和mini, pm和sm则传 true和false, 例如 {"PodAnnotation":"run"}。', + 'type' => 'string', + 'required' => false, + 'example' => '{"PodAnnotation":"run"}', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + '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' => '01FF8DD9-A09C-47A1-895A-B6E321BE77B6', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Job状态。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "PodAnnotation": "run"'."\n" + .' }', + 'description' => '状态值。', + ], + ], + ], + ], + ], + ], + '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' => '更新Feature', + ], + 'RestartEnvironmentFeature' => [ + 'summary' => '重启feature。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境id', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => [ + 'title' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', + 'description' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-agent', + ], + ], + ], + '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' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'success.', + ], + 'Success' => [ + 'description' => '查询是否成功。true：成功。 false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '重启Feature', + ], + 'ListEnvironmentFeatures' => [ + 'summary' => '查询环境中的Feature。', + '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' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境 zh | en，默认为中文。', + 'description' => '语言环境 zh | en，默认为中文。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => '英文', + 'zh' => '中文', + ], + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Config' => [ + 'description' => 'Feature配置。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'Feature配置信息。', + 'example' => '{}', + ], + ], + 'Description' => [ + 'description' => 'Feature描述。', + 'type' => 'string', + 'example' => '以 Prometheus 采集规范采集 Metric 数据。', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'Language' => [ + 'description' => '语言。'."\n" + .'- zh 中文'."\n" + .'- en 英文', + 'type' => 'string', + 'example' => 'zh', + ], + 'LatestVersion' => [ + 'description' => '最新版本号。', + 'type' => 'string', + 'example' => '1.1.17', + ], + 'Name' => [ + 'description' => 'Feature名称。', + 'type' => 'string', + 'example' => 'metric-agent', + ], + 'Status' => [ + 'description' => 'Feature状态。'."\n" + .'- Installing 正在安装'."\n" + .'- Success 安装成功'."\n" + .'- Failed 安装失败'."\n" + .'- UnInstall 已卸载'."\n" + .'- UnInstalling 正在卸载'."\n" + .'- UnInstallFailed 卸载失败', + 'type' => 'string', + 'example' => 'Success', + ], + 'Version' => [ + 'description' => 'Feature版本。', + 'type' => 'string', + 'example' => '1.1.17', + ], + 'Alias' => [ + 'description' => 'Feature别名。', + 'type' => 'string', + 'example' => 'Prometheus 探针', + ], + 'Icon' => [ + 'description' => '图标地址。', + 'type' => 'string', + 'example' => 'http://xxx', + ], + 'Managed' => [ + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询环境中的Feature', + ], + 'DeleteEnvironmentFeature' => [ + 'summary' => '删除feature。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境id', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域id cn-beijing | cn-hangzhou', + 'description' => '地域id cn-beijing | cn-hangzhou', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'FeatureName', + 'in' => 'query', + 'schema' => [ + 'title' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', + 'description' => 'feature的名称 app-agent-pilot | metric-agent | ebpf-agent | service-check', + 'type' => 'string', + 'required' => true, + 'example' => 'metric-agent', + ], + ], + ], + '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' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '提示信息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除feature', + ], + 'CreateEnvCustomJob' => [ + 'summary' => '创建环境的自定义Job。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境实例ID', + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'CustomJobName', + 'in' => 'query', + 'schema' => [ + 'title' => '自定义job名称', + 'description' => '自定义Job名称。', + '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' => '自定义Job的yaml配置串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '返回成功增加的customJob名称，或异常信息。', + 'description' => '返回成功增加的customJob名称，或异常信息。', + 'type' => 'string', + 'example' => 'cutomJob1', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"4C518054-852F-4023-ABC1-4AF95FF7****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"cutomJob1\\",\\n \\"Message\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '创建环境的自定义Job', + '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" + .'```', + ], + 'UpdateEnvCustomJob' => [ + 'summary' => '更新环境的自定义Job。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'CustomJobName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义job名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob1', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '自定义任务状态: run 或 stop', + 'description' => '自定义任务状态: run 或 stop。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'run', + 'enum' => [ + 'run', + 'stop', + ], + ], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => [ + 'description' => 'yaml配置串。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + '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' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'Code' => [ + 'description' => '接口状态或pop错误码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果', + 'description' => '操作结果。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '更新环境的自定义Job', + '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" + .'```', + ], + 'ListEnvCustomJobs' => [ + 'summary' => '查询环境的自定义Job列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'EncryptYaml', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否返回加密后的yaml', + 'description' => '是否返回加密后的yaml。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + ], + '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' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'example' => 'env-xxxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'CustomJobName' => [ + 'description' => '自定义job名称。', + 'type' => 'string', + 'example' => 'job1', + ], + 'ConfigYaml' => [ + 'title' => '请求参数encryptYaml为true，则返回base64编码后的yaml串。否则返回明文yaml串。', + 'description' => '请求参数encryptYaml为true，则返回base64编码后的yaml串。否则返回明文yaml串。', + 'type' => 'string', + 'example' => '参见补充说明。', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'run', + ], + 'CreationTimestamp' => [ + 'description' => '创建时间（时间戳）。', + 'type' => 'string', + 'example' => '2022-01-01T10:11:34Z', + ], + 'AddonName' => [ + 'title' => '归属的组件名', + 'description' => '归属的组件名。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'AddonReleaseName' => [ + 'title' => '归属的组件实例名', + 'description' => '归属的组件实例名。', + 'type' => 'string', + 'example' => 'mysql1', + ], + 'AddonVersion' => [ + 'title' => '归属的组件版本', + 'description' => '归属的组件版本。', + 'type' => 'string', + 'example' => '1.1.0', + ], + 'ScrapeConfigs' => [ + 'description' => '抓取配置。', + 'type' => 'array', + 'items' => [ + 'description' => '抓取配置。', + 'type' => 'object', + 'properties' => [ + 'JobName' => [ + 'description' => 'Job名。', + 'type' => 'string', + 'example' => 'custom-sd-demo', + ], + 'ScrapeInterval' => [ + 'title' => '抓取间隔', + 'description' => '抓取间隔。', + 'type' => 'string', + 'example' => '30s', + ], + 'MetricsPath' => [ + 'title' => '', + 'description' => '抓取metric的路径。', + 'type' => 'string', + 'example' => '/metrics', + ], + 'ScrapeDiscoverys' => [ + 'title' => '服务发现方式列表', + 'description' => '服务发现方式列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务发现方式。', + 'type' => 'string', + 'example' => 'static_configs', + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询环境的自定义Job列表', + '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" + .'```', + ], + 'DescribeEnvCustomJob' => [ + 'summary' => '查询环境CustomJob详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'CustomJobName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '自定义job名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob1', + ], + ], + [ + 'name' => 'EncryptYaml', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否返回加密后的yaml', + 'description' => '是否返回加密后的YAML串。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + ], + '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' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'CustomJobName' => [ + 'description' => '自定义job名称。', + 'type' => 'string', + 'example' => 'customJob1', + ], + 'ConfigYaml' => [ + 'title' => '请求参数encryptYaml为true，则返回base64编码后的yaml串。否则返回明文yaml串。', + 'description' => '请求参数**encryptYaml**为`true`，则返回base64编码后的YAML串。否则返回明文YAML串。', + 'type' => 'string', + 'example' => '参见补充说明。', + ], + 'Status' => [ + 'title' => 'run、stop', + 'description' => '状态：'."\n" + ."\n" + .'- run'."\n" + .'- stop', + 'type' => 'string', + 'enumValueTitles' => [ + 'stop' => 'stop', + 'run' => 'run', + ], + 'example' => 'run', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '查询环境CustomJob详情', + 'responseParamsDescription' => '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' => '删除环境的自定义job。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'CustomJobName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义job名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'job1', + ], + ], + ], + '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' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果描述', + 'description' => '操作结果描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '附加消息', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '删除环境的自定义Job', + ], + 'CreateEnvPodMonitor' => [ + 'summary' => '创建环境的PodMonitor。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境实例ID', + 'description' => '环境实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', + 'description' => '试运行：检查格式是否合法、是否能匹配到targets。', + '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' => 'PodMonitor的YAML配置串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Code' => [ + 'description' => '返回码。返回200代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'MatchedMsg' => [ + 'title' => 'target匹配提示信息', + 'description' => 'target匹配提示信息', + 'type' => 'string', + 'example' => '匹配成功。', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'PodMonitorName' => [ + 'title' => '创建成功的podMonitor名称', + 'description' => '创建成功的podMonitor名称', + 'type' => 'string', + 'example' => 'arms-admin-pm1', + ], + 'MatchedTargetCount' => [ + 'title' => '匹配出的targets数量', + 'description' => '匹配出的targets数量', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '创建环境的PodMonitor', + '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" + .'```'."\n" + .'其中 arms.prometheus.io/discovery 必须存在，其值为“true”，表示serviceMonitor启用，否则表示停止。', + ], + 'DescribeEnvPodMonitor' => [ + 'summary' => '查询环境的PodMonitor详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'podMonitor所在的命名空间', + 'description' => 'PodMonitor所在的命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'PodMonitorName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'PodMonitor名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms-admin-pm1', + ], + ], + ], + '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' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'PodMonitorName' => [ + 'description' => 'PodMonitor名称。', + 'type' => 'string', + 'example' => 'podMonitor1', + ], + 'ConfigYaml' => [ + 'description' => 'PodMonitor的YAML配置串。', + 'type' => 'string', + 'example' => '参见补充说明。', + ], + 'Status' => [ + 'title' => 'run、stop', + 'description' => '状态：'."\n" + ."\n" + .'- run'."\n" + .'- stop', + 'type' => 'string', + 'example' => 'run', + ], + ], + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '查询环境的PodMonitor详情', + 'responseParamsDescription' => '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' => '查询环境的PodMonitor列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + ], + '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' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '操作结果信息。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'PodMonitorName' => [ + 'description' => 'PodMonitor名称。', + 'type' => 'string', + 'example' => 'pm1', + ], + 'ConfigYaml' => [ + 'description' => 'yaml配置串。', + 'type' => 'string', + 'example' => '参见补充说明。', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'run', + ], + 'CreationTimestamp' => [ + 'description' => '创建时间（时间戳）。', + 'type' => 'string', + 'example' => '2011-01-02T11:34:22Z', + ], + 'AddonName' => [ + 'title' => '归属的组件名', + 'description' => '归属的组件名。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'AddonReleaseName' => [ + 'title' => '归属的组件实例名', + 'description' => '归属的组件实例名。', + 'type' => 'string', + 'example' => 'mysql1', + ], + 'AddonVersion' => [ + 'title' => '归属的组件版本', + 'description' => '归属的组件版本。', + 'type' => 'string', + 'example' => '1.0.5', + ], + 'Endpoints' => [ + 'title' => 'podmonitor的podMetricsEndpoints', + 'description' => 'podmonitor的端点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '端点列表。', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '对外端口。', + 'type' => 'string', + 'example' => '9182', + ], + 'TargetPort' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3306', + ], + 'Path' => [ + 'description' => '采集路径。', + 'type' => 'string', + 'example' => '/metrics', + ], + 'Interval' => [ + 'description' => '采集时间间隔。', + 'type' => 'string', + 'example' => '30s', + ], + 'MatchedTargetCount' => [ + 'title' => 'PodMonitor.Endpoint匹配出的target（即pod）数量', + 'description' => 'PodMonitor.Endpoint匹配出的target（即pod）数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '查询环境的PodMonitor列表', + '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" + .'```', + ], + 'UpdateEnvPodMonitor' => [ + 'summary' => '更新环境的PodMonitor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境：'."\n" + ."\n" + .'- zh（默认）：中文 '."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'podMonitor所在的命名空间', + 'description' => 'PodMonitor所在的命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'PodMonitorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'PodMonitor名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms-admin-pm1', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', + 'description' => '试运行。检查格式是否合法、是否能匹配到targets。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => [ + 'description' => 'YAML配置串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'Code' => [ + 'description' => '状态码。'."\n" + ."\n" + .'> 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'MatchedMsg' => [ + 'title' => 'target匹配提示信息', + 'description' => 'target匹配提示信息。', + 'type' => 'string', + 'example' => '匹配成功。', + ], + 'MatchedTargetCount' => [ + 'title' => '匹配出的targets数量', + 'description' => '匹配出的targets数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '更新环境的PodMonitor', + 'requestParamsDescription' => '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' => '删除环境PodMonitor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'podMonitor所在的命名空间', + 'description' => 'podMonitor所在的命名空间', + 'type' => 'string', + 'required' => true, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'PodMonitorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'PodMonitor名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms-admin-pm1', + ], + ], + ], + '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' => '626037F5-FDEB-45B0-804C-B3C92797****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果描述', + 'description' => '操作结果描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除环境PodMonitor', + ], + 'CreateEnvServiceMonitor' => [ + 'summary' => '创建环境的ServiceMonitor。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境：'."\n" + ."\n" + .'- zh（默认）：中文'."\n" + .'- en：英文', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'en' => 'en', + 'zh' => 'zh', + ], + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境实例ID', + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', + 'description' => '试运行。检查格式是否合法、是否能匹配到targets。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + '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' => 'ServiceMonitor的YAML配置串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'MatchedMsg' => [ + 'title' => 'target匹配提示信息', + 'description' => 'Target匹配提示信息。', + 'type' => 'string', + 'example' => '匹配成功。', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'ServiceMonitorName' => [ + 'title' => '成功创建的serviceMonitor名称', + 'description' => '成功创建的ServiceMonitor名称。', + 'type' => 'string', + 'example' => 'arms-admin1', + ], + 'MatchedTargetCount' => [ + 'description' => '匹配出的target数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '创建环境的ServiceMonitor', + 'requestParamsDescription' => '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" + .'其中 arms.prometheus.io/discovery 必须存在，其值为“true”，表示serviceMonitor启用，否则表示停止。', + ], + 'DescribeEnvServiceMonitor' => [ + 'summary' => '查询环境的ServiceMonitor详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'serviceMonitor所在的命名空间', + 'description' => 'ServiceMonitor所在的命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'ServiceMonitorName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => 'ServiceMonitor名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms-admin1', + ], + ], + ], + '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' => '40B10E04-81E8-4643-970D-F1B38F2E****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'EnvironmentId' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'ServiceMonitorName' => [ + 'description' => 'ServiceMonitor名称。', + 'type' => 'string', + 'example' => 'serviceMonitor1', + ], + 'ConfigYaml' => [ + 'description' => 'ServiceMonitor的YAML配置串。', + 'type' => 'string', + 'example' => '参见补充说明。', + ], + 'Status' => [ + 'title' => 'run、stop', + 'description' => '状态：'."\n" + ."\n" + .'- run'."\n" + .'- stop', + 'type' => 'string', + 'example' => 'run', + ], + ], + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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"}]', + 'title' => '查询环境的ServiceMonitor详情', + 'responseParamsDescription' => '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-prometheusapiVersion: 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" + .'```', + ], + 'ListEnvServiceMonitors' => [ + 'summary' => '查询环境的ServiceMonitor列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + ], + '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' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxxx', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'ServiceMonitorName' => [ + 'description' => 'ServiceMonitor名称。', + 'type' => 'string', + 'example' => 'sm1', + ], + 'ConfigYaml' => [ + 'description' => 'yaml配置串。', + 'type' => 'string', + 'example' => '参见补充说明。', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => 'run', + ], + 'CreationTimestamp' => [ + 'description' => '创建时间（时间戳）。', + 'type' => 'string', + 'example' => '2011-10-11T22:32:11Z', + ], + 'AddonName' => [ + 'title' => '归属的组件名', + 'description' => '归属的组件名。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'AddonReleaseName' => [ + 'title' => '归属的组件实例名', + 'description' => '归属的组件实例名。', + 'type' => 'string', + 'example' => 'mysql1', + ], + 'AddonVersion' => [ + 'title' => '归属的组件版本', + 'description' => '归属的组件版本。', + 'type' => 'string', + 'example' => '1.1.0', + ], + 'MatchedServiceCount' => [ + 'title' => '匹配出的service数量', + 'description' => '匹配出的service数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Endpoints' => [ + 'title' => 'ServiceMonitro的endpoints', + 'description' => 'ServiceMonitro的端点列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'podmonitor的端点列表。', + 'type' => 'object', + 'properties' => [ + 'Port' => [ + 'description' => '对外端口。', + 'type' => 'string', + 'example' => '9101', + ], + 'TargetPort' => [ + 'description' => '目标端口。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '443', + ], + 'Path' => [ + 'description' => '采集路径。', + 'type' => 'string', + 'example' => '/metrics', + ], + 'Interval' => [ + 'description' => '采集时间间隔。', + 'type' => 'string', + 'example' => '30s', + ], + 'MatchedTargetCount' => [ + 'title' => 'servcieMonitor.Endpoint匹配出的target数量', + 'description' => 'servcieMonitor.Endpoint匹配出的target数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '查询环境的ServiceMonitor列表', + '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" + .'```', + ], + 'UpdateEnvServiceMonitor' => [ + 'summary' => '更新环境的ServiceMonitor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境, 默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'serviceMonitor所在的命名空间', + 'description' => 'serviceMonitor所在的命名空间。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'ServiceMonitorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceMonitor名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'serviceMonitor1', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '试运行：检查格式是否合法、是否能匹配到targets。', + 'description' => '试运行：检查格式是否合法、是否能匹配到targets。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => [ + 'description' => 'yaml配置串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'MatchedMsg' => [ + 'title' => 'target匹配提示信息', + 'description' => 'target匹配提示信息。', + 'type' => 'string', + 'example' => '匹配成功。', + ], + 'MatchedTargetCount' => [ + 'title' => '匹配出的targets数量', + 'description' => '匹配出的targets数量。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '更新环境的ServiceMonitor', + '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" + .'```', + ], + 'DeleteEnvServiceMonitor' => [ + 'summary' => '删除环境ServiceMonitor。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'description' => '环境实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxxxxx', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => 'serviceMonitor所在的命名空间', + 'description' => 'serviceMonitor所在的命名空间。', + 'type' => 'string', + 'required' => true, + 'example' => 'arms-prom', + ], + ], + [ + 'name' => 'ServiceMonitorName', + 'in' => 'query', + 'schema' => [ + 'description' => 'ServiceMonitor名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms-admin1', + ], + ], + ], + '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' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果描述', + 'description' => '操作结果描述', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '删除环境ServiceMonitor', + ], + 'InstallAddon' => [ + 'summary' => '安装Addon信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon名称', + 'description' => 'Addon名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon版本', + 'description' => 'Addon版本。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.1', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境,默认为中文 zh|en', + 'description' => '语言环境，默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'schema' => [ + 'title' => '输入的元数据 ', + 'description' => '输入的元数据。', + 'type' => 'string', + 'required' => false, + 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', + ], + ], + [ + 'name' => 'ReleaseName', + 'in' => 'query', + 'schema' => [ + 'description' => '安装后的插件名称，如果不指定则生成默认规则名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql-xxxxx', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'title' => '是否试运行, 默认为false', + 'description' => '是否试运行，默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回数据。', + 'type' => 'object', + 'properties' => [ + 'AddonName' => [ + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'AlertRuleCount' => [ + 'description' => '告警组数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Conditions' => [ + 'description' => '安装阶段。', + 'type' => 'array', + 'items' => [ + 'description' => '阶段信息。', + 'type' => 'object', + 'properties' => [ + 'FirstTransitionTime' => [ + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2018-01-31T14:32:19Z', + ], + 'LastTransitionTime' => [ + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2018-01-31T14:32:19Z', + ], + 'Message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Reason' => [ + 'description' => '原因。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Status' => [ + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => 'True', + ], + 'Type' => [ + 'description' => '阶段类型。', + 'type' => 'string', + 'example' => 'Loaded', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'DashboardCount' => [ + 'description' => '大盘数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExporterCount' => [ + 'description' => '插件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'HaveConfig' => [ + 'description' => '是否有配置。', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'InstallUserId' => [ + 'description' => '安装的用户ID。', + 'type' => 'string', + 'example' => '123456', + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'ReleaseId' => [ + 'description' => '安装后的ReleaseID。', + 'type' => 'string', + 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', + ], + 'ReleaseName' => [ + 'description' => 'Release的名称。', + 'type' => 'string', + 'example' => 'mysql-1695372983039', + ], + 'Scene' => [ + 'description' => '定位到的场景。', + 'type' => 'string', + 'example' => 'database', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => '0', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '111', + ], + 'Version' => [ + 'description' => 'Addon版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'Managed' => [ + 'description' => '是否为托管组件。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + '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' => '安装Addon信息', + ], + 'DescribeAddonRelease' => [ + 'summary' => '通过名称查询AddonRelease详情。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'release的名称', + 'description' => 'AddonRelease的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'agent-822567d4-2449', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'Response.', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'ID of the request.', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => 'Release信息。', + 'type' => 'object', + 'properties' => [ + 'Release' => [ + 'description' => 'Release信息。', + 'type' => 'object', + 'properties' => [ + 'AddonName' => [ + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'AlertRuleCount' => [ + 'description' => '告警组数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Conditions' => [ + 'description' => '安装阶段。', + 'type' => 'array', + 'items' => [ + 'description' => '阶段信息。', + 'type' => 'object', + 'properties' => [ + 'FirstTransitionTime' => [ + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2018-01-31T14:32:19Z', + ], + 'LastTransitionTime' => [ + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2018-01-31T14:32:19Z', + ], + 'Message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Reason' => [ + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Status' => [ + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => 'True', + ], + 'Type' => [ + 'description' => '阶段类型。', + 'type' => 'string', + 'example' => 'Loaded', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'DashboardCount' => [ + 'description' => '大盘数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExporterCount' => [ + 'description' => '插件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'HaveConfig' => [ + 'description' => '是否有配置。', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'InstallUserId' => [ + 'description' => '安装的用户ID。', + 'type' => 'string', + 'example' => '23810923891', + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'ReleaseId' => [ + 'description' => '安装后的ReleaseID。', + 'type' => 'string', + 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', + ], + 'ReleaseName' => [ + 'description' => 'Release的名称。', + 'type' => 'string', + 'example' => 'mysql-1695372983039', + ], + 'Scene' => [ + 'description' => '定位到的场景。', + 'type' => 'string', + 'example' => 'database', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => '0', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'UserID' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '13818734031', + ], + 'Version' => [ + 'description' => 'Addon版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'Managed' => [ + 'description' => '是否为托管组件。', + 'type' => 'boolean', + ], + ], + ], + 'Config' => [ + 'description' => 'AddonRelease的配置信息。', + 'type' => 'string', + 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', + ], + ], + ], + ], + ], + ], + ], + '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' => '查看AddonRelease详情', + ], + 'ListAddons' => [ + 'summary' => '新版接入中心产品列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'schema' => [ + 'title' => '查询参数', + 'description' => '查询参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'Regexp', + 'in' => 'query', + 'schema' => [ + 'title' => '查询字段, 是否正则匹配, 默认为false'."\n", + 'description' => '查询字段，是否正则匹配, 默认为false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境,默认为中文 zh | en', + 'description' => '语言环境，默认为中文 zh | en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'title' => '标签筛选', + 'description' => '标签筛选。', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + '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' => '状态码, 200为正常, 其他为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'title' => '提示消息', + 'description' => '提示消息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'title' => '业务是否成功', + 'description' => '业务是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => 'Addon列表数据。', + 'type' => 'array', + 'items' => [ + 'description' => 'Addon信息。', + 'type' => 'object', + 'properties' => [ + 'Alias' => [ + 'description' => 'Addon别名。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Categories' => [ + 'description' => 'Addon标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'cloud', + ], + ], + 'Dashboards' => [ + 'description' => '大盘列表。', + 'type' => 'array', + 'items' => [ + 'description' => '大盘信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '大盘描述。', + 'type' => 'string', + 'example' => 'MySQL监控大盘信息，监控了连接信息、使用信息等指标', + ], + 'Name' => [ + 'description' => '大盘名称。', + 'type' => 'string', + 'example' => 'mysql-overview', + ], + 'Url' => [ + 'description' => '大盘地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + ], + ], + ], + 'Description' => [ + 'description' => 'Addon描述信息。', + 'type' => 'string', + 'example' => '通过 MySQL Exporter 监控数据库指标', + ], + 'Environments' => [ + 'description' => '支持的环境列表。', + 'type' => 'array', + 'items' => [ + 'description' => '环境信息。', + 'type' => 'object', + 'properties' => [ + 'Dependencies' => [ + 'description' => '环境的依赖列表。', + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => '环境依赖的Feature。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'description' => '是否支持。', + 'example' => 'true', + ], + ], + 'Services' => [ + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'ResourceCenter', + ], + ], + 'ClusterTypes' => [ + 'description' => '支持的集群类型。', + 'type' => 'array', + 'items' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'ManagedKubernetes/Default', + ], + ], + ], + ], + 'Description' => [ + 'description' => '环境描述信息。', + 'type' => 'string', + 'example' => 'MySQL 服务部署在 Kubernetes 集群中。', + ], + 'Enable' => [ + 'description' => '是否开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Label' => [ + 'description' => '环境标签。', + 'type' => 'string', + 'example' => '容器环境', + ], + 'Name' => [ + 'description' => '环境名称。', + 'type' => 'string', + 'example' => 'CS', + ], + 'Policies' => [ + 'description' => '环境中的控制策略信息。', + 'type' => 'object', + 'properties' => [ + 'AlertDefaultStatus' => [ + 'description' => '默认告警状态。', + 'type' => 'string', + 'example' => 'default', + ], + 'DefaultInstall' => [ + 'description' => '默认安装状态。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TargetAddonName' => [ + 'description' => 'Addon的Target名称。', + 'type' => 'string', + 'example' => 'cloud-rds-mysql', + ], + 'Protocols' => [ + 'description' => '支持的协议列表。', + 'type' => 'array', + 'items' => [ + 'description' => '协议。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '协议名称。', + 'type' => 'string', + 'example' => 'arms', + ], + 'Label' => [ + 'description' => '协议标签。', + 'type' => 'string', + 'example' => 'ARMS', + ], + 'Icon' => [ + 'description' => '协议图标地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + 'Description' => [ + 'description' => '协议描述。', + 'type' => 'string', + 'example' => 'ARMS', + ], + ], + ], + ], + 'EnableServiceAccount' => [ + 'description' => '是否开启服务账户。', + 'type' => 'boolean', + ], + 'NeedRestartAfterIntegration' => [ + 'description' => '安装后是否需要重启。', + 'type' => 'boolean', + ], + 'MetricCheckRule' => [ + 'description' => '指标正常检查的规则。', + 'type' => 'object', + 'properties' => [ + 'PromQL' => [ + 'description' => 'PromQL查询语句。', + 'type' => 'array', + 'items' => [ + 'description' => 'PromQL查询语句。', + 'type' => 'string', + 'example' => 'scraper_up{scraper=\\"ecs\\"}==1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Icon' => [ + 'description' => '图标地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + 'Keywords' => [ + 'description' => '关键字集合。', + 'type' => 'array', + 'items' => [ + 'description' => '关键字。', + 'type' => 'string', + 'example' => 'Java', + ], + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'Name' => [ + 'description' => 'Addon名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'Once' => [ + 'description' => '是否只能安装一次。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Scene' => [ + 'description' => '定位到的场景。', + 'type' => 'string', + 'example' => 'database', + ], + 'Version' => [ + 'description' => '插件版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'Weight' => [ + 'description' => '权重。', + 'type' => 'string', + 'example' => '857', + ], + 'LatestReleaseCreateTime' => [ + 'description' => '最后一次被创建时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询addon列表', + ], + 'UpgradeAddonRelease' => [ + 'summary' => '更新AddonRelease信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AddonVersion', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon的版本信息', + 'description' => 'Addon的版本信息。', + 'type' => 'string', + 'required' => true, + 'example' => '0.0.2', + ], + ], + [ + 'name' => 'Values', + 'in' => 'query', + 'schema' => [ + 'title' => '元数据信息', + 'description' => '元数据信息。', + 'type' => 'string', + 'required' => true, + 'example' => '{"host":"mysql-service.default","port":3306,"username":"root","password":"roots"}', + ], + ], + [ + 'name' => 'ReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'release的名称', + 'description' => 'Release的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'mysql-1695372983039', + ], + ], + [ + 'name' => 'DryRun', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '是否预检本次请求。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + ], + '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' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '更新AddonRelease信息', + ], + 'ListAddonReleases' => [ + 'summary' => '查询环境中安装的Addon。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '191179', + 'abilityTreeNodes' => [ + 'FEATUREarms7LDEBN', + ], + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '安装环境id', + 'description' => '安装环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon的name信息', + 'description' => 'Addon的名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '查询是否成功：true：成功。 false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Releases' => [ + 'description' => 'AddonRelease集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'AddonRelease集合。', + 'type' => 'object', + 'properties' => [ + 'AddonName' => [ + 'description' => '组件名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'AlertRuleCount' => [ + 'description' => '告警组数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Conditions' => [ + 'description' => '安装阶段。', + 'type' => 'array', + 'items' => [ + 'description' => '阶段信息。', + 'type' => 'object', + 'properties' => [ + 'FirstTransitionTime' => [ + 'description' => '第一次转换时间。', + 'type' => 'string', + 'example' => '2018-01-31T14:32:19Z', + ], + 'LastTransitionTime' => [ + 'description' => '最后一次转换时间。', + 'type' => 'string', + 'example' => '2018-01-31T14:32:19Z', + ], + 'Message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Reason' => [ + 'description' => '失败原因。', + 'type' => 'string', + 'example' => 'xxxx', + ], + 'Status' => [ + 'description' => '阶段状态。', + 'type' => 'string', + 'example' => 'True', + ], + 'Type' => [ + 'description' => '阶段类型。', + 'type' => 'string', + 'example' => 'Loaded', + ], + ], + ], + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'DashboardCount' => [ + 'description' => '大盘数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExporterCount' => [ + 'description' => '插件数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'HaveConfig' => [ + 'description' => '是否有配置。', + 'type' => 'boolean', + 'example' => 'true'."\n", + ], + 'InstallUserId' => [ + 'description' => '安装的用户ID。', + 'type' => 'string', + 'example' => '1268790592387', + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'ReleaseId' => [ + 'description' => '安装后的ReleaseID。', + 'type' => 'string', + 'example' => 'be29c093-3fd6-4fb6-9430-797030cc183a', + ], + 'ReleaseName' => [ + 'description' => 'Release的名称。', + 'type' => 'string', + 'example' => 'mysql-1695372983039', + ], + 'Scene' => [ + 'description' => '定位到的场景。', + 'type' => 'string', + 'example' => 'database', + ], + 'Status' => [ + 'description' => '状态。', + 'type' => 'string', + 'example' => '0', + ], + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '111', + ], + 'Version' => [ + 'description' => 'Addon版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-xxxx', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-heyuan', + ], + 'Managed' => [ + 'description' => '是否是托管组件。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'NextVersion' => [ + 'description' => '最新版本。', + 'type' => 'string', + 'example' => '0.0.4', + ], + 'Config' => [ + 'description' => 'AddonRelease的配置信息。', + 'type' => 'string', + 'example' => '{"port":"9379"}', + ], + ], + ], + ], + 'Total' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询环境中安装的Addon', + ], + 'DeleteAddonRelease' => [ + 'summary' => '通过AddonRelease名称删除AddonRelease数据。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ReleaseName', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon release的名称', + 'description' => 'AddonRelease的名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'agent-822567d4-2449', + ], + ], + [ + 'name' => 'Force', + 'in' => 'query', + 'schema' => [ + 'title' => '是否硬性删除,默认false', + 'description' => '是否硬性删除，默认false。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'Addon名称。', + 'description' => 'Addon名称，当 AddonName 赋值时，将忽略 ReleaseName 参数批量卸载所属于同一个 Addon 的所有 AddonRelease。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回消息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除AddonRelease信息', + ], + 'ListEnvironmentDashboards' => [ + 'summary' => '查询环境中的大盘信息。', + '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' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon的名称,addonName和scene必填一个', + 'description' => 'Addon的名称，AddonName和Scene必填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'trace-java', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'title' => '场景,addonName和scene必填一个', + 'description' => 'Addon的场景，AddonName和Scene必填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '操作结果。', + 'type' => 'object', + 'properties' => [ + 'Dashboards' => [ + 'description' => '大盘列表。', + 'type' => 'array', + 'items' => [ + 'description' => '大盘信息。', + 'type' => 'object', + 'properties' => [ + 'FolderUid' => [ + 'description' => '文件夹UID。', + 'type' => 'string', + 'example' => '1374923841627893', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hongkong', + ], + 'Tags' => [ + 'description' => '关键字。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'k8s', + ], + ], + 'Title' => [ + 'description' => 'Grafana大盘标题。', + 'type' => 'string', + 'example' => 'kafka-instance', + ], + 'Uid' => [ + 'description' => '安装多个Grafana大盘时的大盘唯一标识符，是展示在页面上的唯一业务ID。', + 'type' => 'string', + 'example' => '1537863211936042', + ], + 'Url' => [ + 'description' => 'Grafana大盘的完整URL。', + 'type' => 'string', + 'example' => 'http://xxx', + ], + ], + ], + ], + 'Total' => [ + 'description' => '返回结果的总项目数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询环境中的大盘信息', + ], + 'EnableMetric' => [ + 'summary' => '启用废弃指标。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ccfa5e34a5c1f4ce6b916a40a12151d88', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DropMetric', + 'in' => 'query', + 'schema' => [ + 'description' => '启用指标名。', + 'type' => 'string', + 'required' => false, + 'example' => 'kube_pod_container_status_ready', + ], + ], + ], + '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' => '0231DA4B-3D11-5433-9376-3B5B46C7228D', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加消息', + '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' => '启用单个废弃指标', + ], + 'UpdateMetricDrop' => [ + 'summary' => '更新废弃指标列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'prometheus实例Id。', + 'type' => 'string', + 'required' => false, + 'example' => 'c3ca36c8e2693403d85c0d9f8bb1d7b6c', + ], + ], + [ + 'name' => 'MetricDrop', + 'in' => 'query', + 'schema' => [ + 'description' => '废弃指标列表，每行一个指标名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'apiserver_request_duration_seconds_bucket'."\n" + .'etcd_request_duration_seconds_bucket'."\n" + .'apiserver_request_total'."\n" + .'container_tasks_state', + ], + ], + ], + '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' => 'CCCA4B88-BD7B-5A38-89AF-C09293BD4187', + ], + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '接口状态，取值说明如下：2XX：成功。3XX：重定向。4XX：请求错误。5XX：服务器错误。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::UpdateEnvDropMetricsRule', + ], + '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' => '更新废弃指标列表', + ], + 'UpdatePrometheusMonitoringStatus' => [ + 'summary' => '更新Prometheus实例监控配置状态。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'MonitoringName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控配置名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob'."\n" + .'ecs类型的实例支持：customJob'."\n" + .'不支持probe的状态修改。', + 'description' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob。'."\n" + .'ecs类型的实例支持：customJob。'."\n" + .'不支持probe的状态修改。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => 'run, stop。'."\n" + .'probe不支持状态设置。', + 'description' => '监控配置状态：run, stop。'."\n" + .'probe暂不支持状态设置。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'run', + ], + ], + ], + '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' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果信息', + 'description' => '操作结果信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"21E85B16-75A6-429A-9F65-8AAC9A54****\\",\\n \\"Code\\": 200,\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\"\\n}","type":"json"}]', + 'title' => '更新Prometheus实例监控配置状态', + ], + 'UpdatePrometheusMonitoring' => [ + 'summary' => '更新Prometheus实例监控配置。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'MonitoringName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控配置名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'podMonitor1', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" + .'ecs类型的实例支持：customJob、probe', + 'description' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe。'."\n" + .'ecs类型的实例支持：customJob、probe。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'podMonitor', + ], + ], + [ + 'name' => 'ConfigYaml', + 'in' => 'formData', + 'schema' => [ + 'description' => '监控配置yaml串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '626037F5-FDEB-45B0-804C-B3C92797****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果', + 'description' => '操作结果。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '更新Prometheus实例监控配置', + 'requestParamsDescription' => '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" + .'```', + ], + 'ListPrometheusMonitoring' => [ + 'summary' => '查询Prometheus实例监控配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" + .'ecs类型的实例支持：customJob、probe', + 'description' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe。'."\n" + .'ecs类型的实例支持：customJob、probe。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'serviceMonitor', + ], + ], + ], + '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' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', + ], + 'MonitoringName' => [ + 'description' => '监控配置名称。', + 'type' => 'string', + 'example' => 'podMonitor1', + ], + 'Type' => [ + 'description' => '监控配置类型。', + 'type' => 'string', + 'example' => 'podMonitor', + ], + 'ConfigYaml' => [ + 'description' => '监控配置yaml串。', + 'type' => 'string', + 'example' => '参见返回参数补充说明。', + ], + 'Status' => [ + 'description' => '监控配置状态。', + 'type' => 'string', + 'example' => 'run', + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + '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' => '查询Prometheus实例监控配置', + 'responseParamsDescription' => '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" + .'```', + ], + 'GetPrometheusMonitoring' => [ + 'summary' => '查询Prometheus实例指定监控配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" + .'ecs类型的实例支持：customJob、probe', + 'description' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe。'."\n" + .'ecs类型的实例支持：customJob、probe。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob', + ], + ], + [ + 'name' => 'MonitoringName', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '监控配置名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob1', + ], + ], + ], + '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' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', + ], + 'MonitoringName' => [ + 'description' => '监控配置名称。', + 'type' => 'string', + 'example' => 'customJob1', + ], + 'Type' => [ + 'title' => 'serviceMonitor、podMonitor、customJob、probe', + 'description' => '监控配置类型：serviceMonitor、podMonitor、customJob、probe。', + 'type' => 'string', + 'example' => 'serviceMonitor', + ], + 'Status' => [ + 'title' => 'run, stop', + 'description' => '监控配置状态：run, stop。', + 'type' => 'string', + 'example' => 'run', + ], + 'ConfigYaml' => [ + 'description' => '监控配置yaml串。', + 'type' => 'string', + 'example' => '参见返回参数补充说明。', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '查询Prometheus实例指定监控配置', + 'responseParamsDescription' => '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" + .'```', + ], + 'DeletePrometheusMonitoring' => [ + 'summary' => '删除Prometheus实例监控配置。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" + .'ecs类型的实例支持：customJob、probe', + 'description' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe。'."\n" + .'ecs类型的实例支持：customJob、probe。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'probe', + ], + ], + [ + 'name' => 'MonitoringName', + 'in' => 'query', + 'schema' => [ + 'description' => '监控配置名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'customJob1', + ], + ], + ], + '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' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '操作结果描述', + 'description' => '操作结果描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + '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' => '删除Prometheus实例监控配置', + ], + 'CreatePrometheusMonitoring' => [ + 'summary' => '创建Prometheus实例的监控配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例ID', + 'description' => 'prometheus实例ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'title' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe'."\n" + .'ecs类型的实例支持：customJob、probe', + 'description' => '容器服务类型的实例支持：serviceMonitor、podMonitor、customJob、probe。'."\n" + .'ecs类型的实例支持：customJob、probe。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'serviceMonitor', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'title' => 'run, stop。'."\n" + .'为空时，默认是run。'."\n" + .'probe不支持状态设置，该参数不填。', + 'description' => '监控配置状态：run, stop。'."\n" + .'为空时，默认是run。'."\n" + .'probe暂不支持配置状态，此字段为空。', + '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' => '监控配置yaml串。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'title' => '返回成功增加的remoewrite名称，或异常信息。', + 'description' => '返回成功增加的监控配置名称，或异常信息。', + 'type' => 'string', + 'example' => 'name1', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '创建Prometheus实例的监控配置', + 'requestParamsDescription' => '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" + .'```', + ], + 'AppendInstancesToPrometheusGlobalView' => [ + 'summary' => '增加ARMS Prometheus监控聚合实例中的数据源，将数据源添加到Prometheus聚合实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => true, + 'tenantRelevance' => 'publicInformation', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'Clusters', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例列表，为JSON格式的字符串。', + '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 ]', + ], + ], + [ + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'global-v2-cn-1670100631025794-6gjc0qgb', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Msg' => [ + 'description' => '附加说明信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Info' => [ + 'description' => 'Info级别信息。', + 'type' => 'string', + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源JSON list中，添加失败的单个JSON的list}', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加消息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + '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' => '新增Prometheus实例数据源', + ], + 'AddPrometheusInstance' => [ + 'summary' => '创建RemoteWrite类型Prometheus实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'Remote Write实例类型的名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'notificationpolicy_test', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '实例类型， 目前仅支持Remote Write类型， 简写RW。', + 'type' => 'string', + 'required' => true, + 'example' => 'RW', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。'."\n" + .'{'."\n" + .' "RequestId": 请求ID,'."\n" + .' "Data": "{'."\n" + .' "clusterType": 集群类型,'."\n" + .' "remoteWriteUrl": remote write公网链接,'."\n" + .' "internetGrafanaUrl": Grafana内网链接,'."\n" + .' "authToken": 是否开启Token,'."\n" + .' "internetPushGatewayUrl": PushGateway内网链接,'."\n" + .' "clusterId": 集群ID,'."\n" + .' "internetRemoteReadUrl": remote read内网链接,'."\n" + .' "remoteReadUrl": remote read公网链接,'."\n" + .' "grafanaUrl": Grafana公网链接,'."\n" + .' "pushGatewayUrl": PushGateway公网链接,'."\n" + .' "internetRemoteWriteUrl": 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' => '请求ID。', + 'type' => 'string', + 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', + ], + 'Code' => [ + 'description' => '返回码。返回200代表成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::CreatePrometheusInstance', + ], + ], + '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' => '创建RemoteWrite类型的Prometheus实例', + ], + 'AddPrometheusGlobalViewByAliClusterIds' => [ + 'summary' => '增加ARMS Prometheus监控的聚合实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '特定集群创建定制大盘的产品标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'adcp', + ], + ], + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID列表，可以是多个，需要用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Msg' => [ + 'description' => '附加说明信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Info' => [ + 'description' => 'Info级别信息。', + 'type' => 'string', + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '3A0EA2AF-C9B3-555C-B9D5-5DD8F5EF98A9', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '新增容器聚合实例', + ], + 'AddPrometheusGlobalView' => [ + 'summary' => '增加ARMS Prometheus监控的聚合实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'Clusters', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例列表，为JSON格式字符串。', + '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 ]', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2eq4pecazwfy', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'http.status_code', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '查询是否成功。'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Msg' => [ + 'description' => '附加说明信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Info' => [ + 'description' => 'Info级别信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'GlobalViewClusterId' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'example' => 'global-v2-cn-1483223059272121-jmjjfznz', + ], + 'FailedInstances' => [ + 'description' => '添加失败的实例列表。', + 'type' => 'string', + 'example' => '[{"sourceName": "数据源名称- ArmsPrometheus","sourceType":"AlibabaPrometheus","userId":"UserID","clusterId":"ClusterId",}]', + ], + ], + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedInstances: 数据源JSON list中，添加失败的单个JSON的list}', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + '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' => '新增聚合实例', + ], + 'AddAliClusterIdsToPrometheusGlobalView' => [ + 'summary' => '增加ARMS Prometheus监控聚合实例的数据源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', + ], + ], + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID列表，可以是多个，需要用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '是否新增成功。'."\n" + ."\n" + .'- `true`：成功'."\n" + .'- `false`：失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Msg' => [ + 'description' => '附加说明信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Info' => [ + 'description' => 'Info级别信息。', + 'type' => 'string', + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误，或者跨大洲添加）}', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '新增聚合实例数据源', + ], + 'AddRecordingRule' => [ + 'summary' => '创建或者更新Prometheus监控的RecordingRule规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'RuleYaml', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义的RecordingRule聚合规则，其设置需要符合YAML格式。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'Data' => [ + 'description' => '响应状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '创建RecordingRule', + ], + 'SyncRecordingRules' => [ + 'summary' => '将某个集群的聚合规则批量同步到全Region的其他目标集群。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '被同步的集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'TargetClusters', + 'in' => 'query', + 'schema' => [ + 'description' => '批量的目标集群ID内容。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '{ "cn":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***" ], "us":[ "ce30f833bc4a04a56a06b070319***" ], "jp":[ ], "ap":[ ], "gov":[ ], "finance":[ ] }', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。（可以和被同步集群所属的RegionId一致）', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'string', + 'example' => '{ "data":[ "c06ca68cd16f14f52bb07772eda***", "c33dd70a0ac184c1b879d807ab2***", "c384cf7e4dcb543e6ac8c7d4dd3***", "ce30f833bc4a04a56a06b070319***" ], "message":"设置RecordingRule失败的clusterIds", "success":true }', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + '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' => '将某个集群的聚合规则批量同步到全Region的其他目标集群', + 'requestParamsDescription' => '注意：**TargetClusters**参数是用于批量同步目标集群的内容设定，需要严格根据定义的参数格式传参；其是一个JSON格式对象，对象中的每个元素是一个数组，用户可以在对应的元素中添加对应的集群ID；下面是特定的参数格式及每个元素代表的区域说明（需要将目标集群ID填入对应的区域数组元素中）： { "cn":[], //中国 "eu":[], //欧洲 "us":[], //美洲 "jp":[], //日本 "ap":[], //亚太 "gov":[], //政务云 "finance":[] //金融云 }'."\n", + 'responseParamsDescription' => '注意：返参**Data**中，若success为true，则表明此次调用成功，否则调用失败；若data内容不为空，则表明此次调用中存在设置失败的目标集群，失败原因或许和集群自身或和网络请求超时有关，需要自行查看核实，或者将失败集群归类后再次调用。', + ], + 'AddIntegration' => [ + 'summary' => '集成ARMS Prometheus监控的大盘以及采集规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Integration', + 'in' => 'query', + 'schema' => [ + 'description' => 'ARMS支持的软件缩写。可选值（不区分大小写）：`ASM`、`IoT`和`Flink`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::InstallAddon', + ], + ], + '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' => '集成大盘及采集规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetIntegrationState' => [ + 'summary' => '来获取Integration的接入状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + '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****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => 'The region ID.', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Integration', + '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', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'The response schema.', + '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', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::DescribeAddonRelease', + ], + ], + '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' => '获取Integration的接入状态', + ], + 'DeleteIntegration' => [ + 'summary' => '删除Integration接入的采集规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Integration', + 'in' => 'query', + 'schema' => [ + 'description' => 'ARMS支持的软件缩写。可选值（不区分大小写）：`ASM`、`IoT`和`Flink`。', + 'type' => 'string', + 'required' => true, + 'example' => 'asm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::DeleteAddonRelease', + ], + ], + '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' => '删除Integration接入的采集规则', + ], + 'AddGrafana' => [ + 'summary' => '集成ARMS Prometheus监控的大盘。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Integration', + 'in' => 'query', + 'schema' => [ + 'description' => 'ARMS支持的软件缩写。可选值（不区分大小写）：`ASM`、`IoT`和`Flink`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'asm', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + ], + ], + ], + ], + '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' => '集成Prometheus监控大盘', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'InstallCmsExporter' => [ + 'summary' => '安装云服务采集器。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'CmsArgs', + 'in' => 'query', + 'schema' => [ + 'title' => '云监控接入方式支持的参数，多个产品名用#分隔', + 'description' => 'cms-exporter启动参数，表示需要监控哪些云产品。多个云产品之间用`#`分割。'."\n" + ."\n\n", + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'hologres#cen', + ], + ], + [ + 'name' => 'EnableTag', + 'in' => 'query', + 'schema' => [ + 'description' => '是否采集云产品相关aliyun tag标签，可选参数，默认false。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'false', + 'default' => 'true', + ], + ], + [ + 'name' => 'DirectArgs', + 'in' => 'query', + 'schema' => [ + 'title' => '一方接入方式支持的参数，多个产品名用#分隔', + 'description' => '最近监控的云产品。多个云产品之间用`#`分割。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'hologres#cen', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1', + ], + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::InstallAddon', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '安装云服务采集器', + ], + 'OpenVCluster' => [ + 'summary' => '开通虚拟集群。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型，云产品统一为`cloud-product-prometheus`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cloud-product-prometheus', + ], + ], + [ + 'name' => 'Length', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID长度，默认为10。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品名称，当`clusterType=cloud-product-prometheus`时该字段必传。目前已经接入的云产品名为influxdb、mongodb、DLA，该参数不支持传入多个。', + 'type' => 'string', + 'required' => false, + 'example' => 'influxdb', + ], + ], + [ + 'name' => 'RecreateSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '创建或者查询虚拟集群开关参数，可以对老数据兼容控制。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '集群ID，为字符串格式。', + 'type' => 'string', + 'example' => 'rre59xelcx', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '42E58E4D-ACAD-4400-8FAF-F762340AE5B3', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"rre59xelcx\\",\\n \\"RequestId\\": \\"42E58E4D-ACAD-4400-8FAF-F762340AE5B3\\"\\n}","type":"json"}]', + 'title' => '开通虚拟集群', + ], + 'DeletePrometheusGlobalView' => [ + 'summary' => '删除Prometheus聚合实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'global-v2-cn-1670100631025794-amaykca4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'JSON格式的返回结果。', + 'type' => 'string', + 'example' => '{"Success":true,"Msg":"OK"}', + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加消息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除Prometheus聚合实例', + ], + 'RemoveAliClusterIdsFromPrometheusGlobalView' => [ + 'summary' => '移除ARMS Prometheus监控聚合实例的某些数据源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'global-v2-cn-1670100631025794-amaykca4', + ], + ], + [ + 'name' => 'ClusterIds', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID列表，可以是多个，需要用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cd1d55bef19904324a20ed0ebb86caa5c,c5b48729918ab4745a24482ac29d0973a, c00a94896641449098bf24931e4166003, cd174485c09384060ba542bc1be1185a4', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Msg' => [ + 'description' => '附加说明信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Info' => [ + 'description' => 'Info级别信息。', + 'type' => 'string', + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id, failedClusterIds: 添加失败的AliClusterId（一般是clusterId有误）}', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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 \\"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' => '删除聚合实例数据源', + ], + 'RemoveSourcesFromPrometheusGlobalView' => [ + 'summary' => '移除ARMS Prometheus监控聚合实例中的数据源，仅支持删除非阿里数据源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', + ], + ], + [ + 'name' => 'SourceNames', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义数据源的SourceName列表，可以是多个，需要用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'localPrometheusClusterName,testCumterPrometheusName', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Msg' => [ + 'description' => '附加说明信息。', + 'type' => 'string', + 'example' => 'OK', + ], + 'Info' => [ + 'description' => 'Info级别信息。', + 'type' => 'string', + 'example' => '{regionId: 实例所属region, globalViewClusterId: 实例Id}', + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '删除聚合实例非阿里数据源', + ], + 'DeleteCmsExporter' => [ + 'summary' => '来卸载Prometheus for 云服务实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应内容。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '本次调用的唯一ID。出现错误后，您可以根据该ID排查问题。', + 'type' => 'string', + 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + 'Data' => [ + 'description' => '返回结果信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::DeleteAddonRelease', + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '卸载Prometheus for 云服务实例', + ], + 'DelAuthToken' => [ + 'summary' => '关闭鉴权token。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求的ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C647A', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"success\\",\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C647A\\"\\n}","type":"json"}]', + 'title' => '关闭鉴权token', + ], + 'DeleteGrafanaResource' => [ + 'summary' => '删除ARMS Prometheus监控集群中的Grafana大盘资源。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'clusterNameOfTest', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'delete success.', + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '771DC66C-C5E0-59BC-A983-DD18FEE9EFFA', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除集群的大盘资源', + ], + 'UninstallPromCluster' => [ + 'summary' => '来卸载ARMS Prometheus集群实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'title' => '语言环境, 默认为中文 zh | en', + 'description' => '语言环境（若不填，默认为 zh）：'."\n" + .'- zh '."\n" + .'- en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '53980F48-DE82-53A1-9ADE-D2629226DD9A', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '卸载prometheus集群', + ], + 'QueryPromInstallStatus' => [ + 'summary' => '来查询ARMS Prometheus集群的安装状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID，一次请求的唯一标识。'."\n", + 'type' => 'string', + 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'isControllerInstalled' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'true：成功。'."\n" + .'false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": {\\n \\"isControllerInstalled\\": true\\n }\\n}","type":"json"}]', + 'title' => '查询集群安装状态', + ], + 'ListPrometheusGlobalView' => [ + 'summary' => '增加ARMS Prometheus监控的聚合实例，获取聚合实例列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '聚合实例列表，为JSON格式字符串。', + 'type' => 'string', + 'example' => '[ {groupName: "聚合实例名称", clusterId: "global-v2-clusterid", endpoint: "cn-hangzhou"}, // ..... more items ]', + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'DBDCE95A-A0DD-5FC5-97CC-EEFC3D814385', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '详细信息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '获取聚合实例列表', + ], + 'GetPrometheusGlobalView' => [ + 'summary' => '增加ARMS Prometheus监控的聚合实例，获取指定聚合实例的详细数据源情况。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GlobalViewClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'global-v2-cn-1478326682034601-vss8pd0i', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'string', + 'example' => '{ "clusterId":"聚合实例ClusterId", "groupName":"聚合实例名称", "dataSources":[ { "sourceName":"数据源名称- ArmsPrometheus No.1", "sourceType":"AlibabaPrometheus", "userId":"UserID", "clusterId":"ClusterId" }, // more datasources ] }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '743AD493-D006-53BD-AAEC-DDCE7FB68EA7', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '获取聚合实例的数据源详情', + ], + 'CheckServiceStatus' => [ + 'summary' => '检查集群当前的服务状态，例如是否开通服务，是否欠费等。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '44423', + 'abilityTreeNodes' => [ + 'FEATUREarms7LDEBN', + ], + ], + 'parameters' => [ + [ + 'name' => 'SvcCode', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云ServiceCode。 Arms Prometheus对应的ServiceCode为prometheus。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'prometheus', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '5710C923-AD09-4293-9E11-DCBE3D15F8D4', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"true\\",\\n \\"RequestId\\": \\"5710C923-AD09-4293-9E11-DCBE3D15F8D4\\"\\n}","type":"json"}]', + 'title' => '检查产品开通状态', + ], + 'GetPrometheusApiToken' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Token' => [ + 'description' => '集成ARMS Prometheus监控所需的Token。', + 'type' => 'string', + 'example' => '6dcbb77ef4ba6ef5466b5debf9e2****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + ], + ], + ], + ], + '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' => '获取Prometheus监控所需Token', + 'summary' => '获取集成ARMS Prometheus监控所需的Token。', + 'description' => '暂无。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'GetExploreUrl' => [ + 'summary' => '获取使用Grafana的Explore功能。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c9cc4c5e220f8461f9d71b6ec6e******', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana数据源类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'loki' => 'loki', + 'prometheus' => 'prometheus', + ], + 'example' => 'prometheus', + ], + ], + [ + 'name' => 'Expression', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源对应的查询语句。', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + '{level="WARN"}' => '{level="WARN"}', + '{level="ERROR"}' => '{level="ERROR"}', + ], + 'example' => '{app="buy2"}', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回数据', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '获取Grafana的Explore功能', + ], + 'ListDashboards' => [ + 'summary' => '获取集群的Grafana大盘的列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型，包括：ACK、ASK、cloud-product-prometheus和Node。虚拟集群可通过集群类型查询大盘列表。InfluxDB类云产品统一传`cloud-product-prometheus`。', + 'type' => 'string', + 'required' => false, + 'example' => 'Node', + ], + ], + [ + 'name' => 'Language', + 'in' => 'query', + 'schema' => [ + 'description' => '指定返回的Grafana大盘的语言，参数值包括en 、 zh ，默认值为en。', + 'type' => 'string', + 'required' => false, + 'example' => 'en', + ], + ], + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '指定大盘标题。大盘标题可能会修改，建议使用**DashboardName**查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'ApiServer', + ], + ], + [ + 'name' => 'Product', + 'in' => 'query', + 'schema' => [ + 'description' => '云产品Code，可选。当`clusterType=cloud-product-prometheus`时该字段必传。目前已经接入的云产品有：SAE、MSE、RocketMQ、Lindorm、Kafka、Clickhouse、DLA、消息队列RabbitMQ版、云数据库MongoDB版、时序数据库InfluxDB、MSE服务-云原生网关、Grafana服务、分布式调度平台SchedulerX、MSE服务-全局事务、企业级分布式应用服务EDAS、机器学习平台PAI-EAS、应用高可用服务AHAS、性能测试PTS。', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + [ + 'name' => 'RecreateSwitch', + 'in' => 'query', + 'schema' => [ + 'description' => '创建或者查询虚拟集群开关参数，可以对老数据兼容控制。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'DashboardName', + 'in' => 'query', + 'schema' => [ + 'description' => '大盘唯一名称，可筛选查询指定名称的大盘。相对于**Title**参数，**Title**可能会发生变化，name不会。并且支持指定多个name，以半角逗号（,）分隔，例如：`k8s-event,k8s-overview`。同一个大盘名称会有多个版本，如果要指定版本，可以在name后面增加版本信息，例如：`k8s-event:v1,k8s-overview:latest`。', + 'type' => 'string', + 'required' => false, + 'example' => 'k8s-node-overview', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'DashboardVos' => [ + 'description' => 'Grafana大盘信息。', + 'type' => 'array', + 'items' => [ + 'description' => 'grafana大盘信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Grafana大盘类型，包括：'."\n" + ."\n" + .'- `dash-db`：大盘'."\n" + .'- `dash-folder`：文件夹（可包含大盘）', + 'type' => 'string', + 'example' => 'dash-db', + ], + 'Time' => [ + 'description' => 'Grafana大盘创建时间的时间戳。单位 ：秒', + 'type' => 'string', + 'example' => '1590136924', + ], + 'NeedUpdate' => [ + 'description' => '大盘是否有新版本可以升级。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Kind' => [ + 'description' => '大盘种类，为BASIC（基础类型）、THIRD（第三方）、LIMIT（限时免费）、CUSTOM（自定义）的其中一种。', + 'type' => 'string', + 'example' => 'BASIC', + ], + 'Language' => [ + 'description' => 'Grafana大盘使用的语言。', + 'type' => 'string', + 'example' => 'en', + ], + 'Url' => [ + 'description' => 'Grafana大盘的完整URL。', + 'type' => 'string', + 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', + ], + 'HttpsUrl' => [ + 'description' => 'Grafana大盘URL。', + 'type' => 'string', + 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', + ], + 'DashboardType' => [ + 'description' => '大盘类型，作用与Exporter一致，但是字段含义更明确。', + 'type' => 'string', + 'example' => 'Node', + ], + 'Exporter' => [ + 'description' => 'Exporter接入源的类型，包括：'."\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', + 'type' => 'string', + 'example' => 'Nginx', + ], + 'Version' => [ + 'description' => '大盘版本，与Name形成唯一键，确定一个大盘。', + 'type' => 'string', + 'example' => 'v2', + ], + 'IsArmsExporter' => [ + 'description' => '是否属于ARMS提供的Exporter：'."\n" + ."\n" + .'- `true`：是ARMS提供的Exporter。'."\n" + .'- `false`：不是ARMS提供的Exporter。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HttpUrl' => [ + 'description' => 'Grafana大盘的URL。', + 'type' => 'string', + 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', + ], + 'Title' => [ + 'description' => 'Grafana大盘标题。', + 'type' => 'string', + 'example' => 'ApiServer', + ], + 'Name' => [ + 'description' => '大盘名称，与**Title**不同，不会修改。', + 'type' => 'string', + 'example' => 'k8s-node-overview', + ], + 'Id' => [ + 'description' => 'Grafana大盘ID，仅在安装Grafana大盘时是唯一的。', + 'type' => 'string', + 'example' => '1100**', + ], + 'Uid' => [ + 'description' => '安装多个Grafana大盘时的大盘唯一标识符，是展示在页面上的唯一业务ID。', + 'type' => 'string', + 'example' => '1131971649496228-*****-59', + ], + 'Tags' => [ + 'description' => 'Grafana大盘标签。', + 'type' => 'array', + 'items' => [ + 'description' => 'Grafana大盘标签。', + 'type' => 'string', + 'example' => '["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]', + ], + ], + 'I18nChild' => [ + 'description' => 'Grafana大盘信息。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => 'Grafana大盘类型，包括：'."\n" + ."\n" + .'- `dash-db`：大盘'."\n" + .'- `dash-folder`：文件夹（可包含大盘）', + 'type' => 'string', + 'example' => 'dash-db', + ], + 'Time' => [ + 'description' => 'Grafana大盘创建时间的时间戳。', + 'type' => 'string', + 'example' => '1590136924', + ], + 'NeedUpdate' => [ + 'description' => '大盘是否有新版本可以升级。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Kind' => [ + 'description' => '大盘种类，为basic、third、limit、custom的其中一种。', + 'type' => 'string', + 'example' => 'BASIC', + ], + 'Language' => [ + 'description' => 'Grafana大盘使用的语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'Url' => [ + 'description' => 'Grafana大盘的完整URL。', + 'type' => 'string', + 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', + ], + 'HttpsUrl' => [ + 'description' => 'Grafana大盘的URL。', + 'type' => 'string', + 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', + ], + 'DashboardType' => [ + 'description' => '大盘类型，作用与Exporter一致，但是字段含义更明确。', + 'type' => 'string', + 'example' => 'Node', + ], + 'Exporter' => [ + 'description' => 'Exporter接入源的类型，包括：'."\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', + 'type' => 'string', + 'example' => 'Nginx', + ], + 'Version' => [ + 'description' => '大盘版本，与Name形成唯一键，确定一个大盘。', + 'type' => 'string', + 'example' => 'v2', + ], + 'IsArmsExporter' => [ + 'description' => '是否属于ARMS提供的Exporter：'."\n" + ."\n" + .'- `true`：是ARMS提供的Exporter。'."\n" + .'- `false`：不是ARMS提供的Exporter。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'HttpUrl' => [ + 'description' => 'Grafana大盘的URL。', + 'type' => 'string', + 'example' => 'http://g.console.aliyun.com/d/1131971649496228-*****-59/ApiServer?orgId=3**&refresh=60s', + ], + 'Title' => [ + 'description' => 'Grafana大盘标题。', + 'type' => 'string', + 'example' => 'ApiServer', + ], + 'Name' => [ + 'description' => '大盘名称，与**Title**不同，不会修改。', + 'type' => 'string', + 'example' => 'k8s-node-overview', + ], + 'Id' => [ + 'description' => 'Grafana大盘ID，仅在安装Grafana大盘时是唯一的。', + 'type' => 'string', + 'example' => '1100**', + ], + 'Uid' => [ + 'description' => '安装多个Grafana大盘时的大盘唯一标识符，是展示在页面上的唯一业务ID。', + 'type' => 'string', + 'example' => '1131971649496228-*****-59', + ], + 'Tags' => [ + 'description' => 'Grafana大盘标签。', + 'type' => 'array', + 'items' => [ + 'description' => 'Grafana大盘标签。', + 'type' => 'string', + 'example' => '["arms-k8s","ccc8ce1fe0c9543629e39ee657e34****"]', + ], + ], + ], + ], + ], + ], + ], + 'PrometheusServiceOpened' => [ + 'description' => '是否开通Prometheus服务。', + 'type' => 'string', + 'example' => 'true', + ], + 'EnvironmentId' => [ + 'description' => '环境ID。', + 'type' => 'string', + 'example' => 'env-ebd54733482581fc8c4237******', + ], + 'GrafanaServiceOpened' => [ + 'description' => '是否开通Grafana服务。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '获取集群的大盘列表', + 'description' => '暂无。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListClusterFromGrafana' => [ + 'summary' => '列出指定地域下的所有Grafana大盘。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '6849D41E-EED4-5C00-89F9-6047BBD9DCB4', + ], + 'PromClusterList' => [ + 'description' => '用户集群信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Grafana大盘信息。', + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '更新时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-11-16T08:49:34Z', + ], + 'CreateTime' => [ + 'description' => '创建时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2021-12-09T02:05:04Z', + ], + 'UserId' => [ + 'description' => '集群所属用户的主账号ID。', + 'type' => 'string', + 'example' => '1247285**', + ], + 'Options' => [ + 'description' => '自定义参数。', + 'type' => 'string', + 'example' => '{\'Option\': [\'betaTestApproved\']}', + ], + 'IsControllerInstalled' => [ + 'description' => 'Prometheus监控的安装状态：'."\n" + ."\n" + .' - true：已安装'."\n" + .' - false：未安装', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AgentStatus' => [ + 'description' => '集群的Agent状态。包括：'."\n" + ."\n" + .'- INSTALL_FAILED：安装失败'."\n" + .'- INSTALL_SUCCEED：安装成功'."\n" + .'- NOT_REGISTER：未注册', + 'type' => 'string', + 'example' => 'INSTALL_FAILED', + ], + 'Extra' => [ + 'description' => '扩展字段，JSON字符串。', + 'type' => 'string', + 'example' => '{\\"app_id\\":\\"bbd\\",\\"task_id\\":\\"4305ba5bf14942daa6e553ed91f46988\\"}', + ], + 'InstallTime' => [ + 'description' => '安装时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653532518000', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'ControllerId' => [ + 'description' => '管控角色ID。', + 'type' => 'string', + 'example' => '1092', + ], + 'PluginsJsonArray' => [ + 'description' => 'nodejsonar类型的日志列表。', + 'type' => 'string', + 'example' => '{}', + ], + 'ClusterType' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'cloud-product-prometheus', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + 'type' => 'string', + 'example' => 'ay-ads-hangzhou', + ], + 'StateJson' => [ + 'description' => '集群的应用部署情况。', + 'type' => 'string', + 'example' => '{}', + ], + 'LastHeartBeatTime' => [ + 'description' => '上次心跳汇报时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1653532518000', + ], + 'NodeNum' => [ + 'description' => '节点数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '3', + ], + 'Id' => [ + 'description' => '集群数据库记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '16136', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c0df7ad9db0ed43128925ca04774c469e', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '列出指定地域下的所有Grafana大盘', + ], + 'GetRecordingRule' => [ + 'summary' => '获取集群的RecordingRule聚合规则。', + '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' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'Data' => [ + 'description' => '获取到的集群RecordingRule聚合规则。', + 'type' => 'string', + 'example' => '--- groups: - name: "recording_demo" rules: - expr: "sum(jvm_memory_max_bytes)" record: "rate_coredns_demo"', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '暂无替代API，请关注后续API最新发布。', + ], + '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' => '获取聚合规则', + ], + 'ListCmsInstances' => [ + 'summary' => '查询云服务采集状态。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'n9p9o9o3se', + ], + ], + [ + 'name' => 'TypeFilter', + 'in' => 'query', + 'schema' => [ + 'description' => '集成的云服务类型。包括：'."\n" + ."\n" + .'- direct: 云产品自监控集成'."\n" + .'- cms: 企业云监控集成', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'direct', + 'enum' => [ + 'cms', + 'direct', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E7A04B0D-E2CA-59BB-8A9D-D5D349C22BF1', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'EnableTag' => [ + 'description' => '是否采集云产品相关aliyun tag标签。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Products' => [ + 'description' => '返回结构体。', + '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' => '实例ID。', + 'type' => 'string', + 'example' => '20210', + ], + 'State' => [ + 'description' => 'Integration的接入状态。'."\n" + ."\n" + .'- `true`：表示已接入。'."\n" + .'- `false`：表示未接入。'."\n", + 'type' => 'string', + 'example' => 'true', + ], + 'Time' => [ + 'description' => 'Grafana大盘创建时间的时间戳。', + 'type' => 'string', + 'example' => '1647852021000', + ], + 'Type' => [ + 'description' => '产品类型。', + 'type' => 'string', + 'example' => 'HOLOGRES', + ], + 'Url' => [ + 'description' => 'Grafana大盘的完整URL。', + 'type' => 'string', + 'example' => 'https://g.console.aliyun.com/d/1098370038733503-35894-565/cms-hologres?orgId\\u003d9\\u0026refresh\\u003d60s', + ], + 'Source' => [ + 'description' => '事件来源。', + 'type' => 'string', + 'example' => 'arms', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询云服务采集状态', + ], + 'ListDashboardsByName' => [ + 'summary' => '来创建与Prometheus关联的Loki数据源和相关的多数据源大盘。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。当ClusterType不为`cloud-product-prometheus`或`cms-enterprise-prometheus`的时候，需要传递ClusterId。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'DataSourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '数据源类型。'."\n" + ."\n" + .'- loki （Loki数据源）'."\n" + .'- prometheus （Prometheus数据源）', + 'type' => 'string', + 'required' => false, + 'example' => 'loki', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'description' => '集群类型。'."\n" + ."\n" + .'- vpc-prometheus （Prometehus for ECS集群）'."\n" + .'- cloud-product-prometheus （云服务集群）'."\n" + .'- cms-enterprise-prometheus （企业云监控服务集群）'."\n" + .'- ExternalKubernetes （容器服务注册集群）'."\n" + .'- Ask （Serverless集群）'."\n" + .'- Kubernetes（容器服务专业版集群）'."\n" + .'- ManagedKubernetes （容器服务托管版集群）'."\n" + .'- remote-write-prometheus（Prometheus for Remote Write集群）'."\n" + .'- GlobalViewV2（Prometheus for GlobalView 集群）', + 'type' => 'string', + 'required' => false, + 'example' => 'cloud-product-prometheus', + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '云服务名称缩写。', + 'type' => 'string', + 'required' => false, + 'example' => 'edas', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '大盘分组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'EDAS', + ], + ], + [ + 'name' => 'DashBoardName', + 'in' => 'query', + 'schema' => [ + 'description' => '大盘名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'edas-ingress-url', + ], + ], + [ + 'name' => 'DashBoardVersion', + 'in' => 'query', + 'schema' => [ + 'description' => '大盘版本。', + 'type' => 'string', + 'required' => false, + 'example' => 'latest', + ], + ], + [ + 'name' => 'OnlyQuery', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana大盘是否仅展示在控制台上。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应内容。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + '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' => '请求的ID。用于定位日志，排查问题。', + 'type' => 'string', + 'example' => '2983BEF7-4A0D-47A2-94A2-8E9C5E63****', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '创建Loki数据源和相关的多数据源大盘', + ], + 'GetAuthToken' => [ + 'summary' => '获取公网读写鉴权Token。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回Token信息。', + 'type' => 'string', + 'example' => 'eyJhbGciOiJIUzI1NiJ9******', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '附加信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '查询是否成功：true：成功。 false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '获取公网读写鉴权', + ], + 'GetClusterAllUrl' => [ + 'summary' => '获取集群所有地址。包括远程读写地址、 Push Gateway地址、 Grafana地址。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => 'JSON格式的返回结果。', + 'type' => 'string', + 'example' => '{'."\n" + .' "RequestId": "41877338-646B-5DD6-BFBE-F89F1E7245AD",'."\n" + .' "Data": "{\\"clusterType\\":\\"ManagedKubernetes\\",\\"remoteWriteUrl\\":\\"http:/" }', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '40B10E04-81E8-4643-970D-F1B38F2E****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '查询是否成功：true：成功。 false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'substitutions' => [ + 'ARMS::2019-08-08::GetPrometheusInstance', + ], + ], + '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' => '获取集群所有地址', + ], + 'GetCloudClusterAllUrl' => [ + 'summary' => '获取云监控云产品读写地址，pushgateway，grafana 地址。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。例如cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '云监控实例ID', + 'type' => 'string', + 'required' => false, + 'example' => 'ca9676014babd4', + ], + ], + ], + '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' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', + ], + 'Data' => [ + 'description' => '数组类型', + 'type' => 'array', + 'items' => [ + 'description' => '聚合实例列表，为JSON格式字符串。', + 'type' => 'object', + 'properties' => [ + 'ProductCode' => [ + 'description' => '云产品标识', + 'type' => 'string', + 'example' => 'amp', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'RemoteUrl' => [ + 'description' => '读写对象json结构', + 'type' => 'object', + 'properties' => [ + 'RemoteWriteUrl' => [ + 'description' => '内网远程写地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'InternetRemoteWriteUrl' => [ + 'description' => '公网远程写地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'RemoteReadUrl' => [ + 'description' => '内网远程读地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'InternetRemoteReadUrl' => [ + 'description' => '公网远程读地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"', + ], + 'GrafanaUrl' => [ + 'description' => '内网grafana数据源地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'InternetGrafanaUrl' => [ + 'description' => '公网grafana数据源地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'InternetPushGatewayUrl' => [ + 'description' => '公网pushgateway 地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'PushGatewayUrl' => [ + 'description' => '内网pushgateway 地址', + 'type' => 'string', + 'example' => '"http://cn-hangzhou-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/XXXXXXXXXXXXXXXXX"'."\n", + ], + 'AuthToken' => [ + 'description' => '是否开启鉴权', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Token' => [ + 'description' => '如果开启，token的值', + 'type' => 'string', + 'example' => '"eyJhbGciOiJIUzI1NiJ9.DKEIFJSL.KYK6uOtNVxTVHXJbH5MNqlsAuUtKzNlUvmAIiKc-QXw"', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '详细信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '获取云产品各种URL', + ], + 'ListPrometheusInstances' => [ + 'summary' => '获取Prometheus的所有正常实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '实例类型。', + 'description' => '可选实例类型（若不填则为查询所有类型的实例）：'."\n" + .'- cloud-product-prometheus （Region级云服务旧版）'."\n" + .'- ManagedKubernetes （容器服务ACK托管版类型）'."\n" + .'- satellite （Prometheus for ARMS OpenTelemetry）'."\n" + .'- Ask （容器服务ACK Serverless集群类型）'."\n" + .'- remote-write-prometheus （通用实例）'."\n" + .'- cloud-monitor-cmee （企业云监控）'."\n" + .'- ExternalKubernetes （容器服务注册集群类型）'."\n" + .'- vpc-prometheus （Prometheus for ECS）'."\n" + .'- cloud-monitor-direct （云服务自监控）'."\n" + .'- Edge Kubernetes （容器服务Edge集群类型）', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'enumValueTitles' => [], + 'example' => 'cloud-product-prometheus', + ], + ], + [ + 'name' => 'ShowGlobalView', + 'in' => 'query', + 'schema' => [ + 'description' => '是否获取GlobalView聚合实例：'."\n" + .' - true：获取'."\n" + .' - false：不获取', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回实例JSON。', + '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' => '请求ID，用于定位日志，排查问题。'."\n", + 'type' => 'string', + 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', + ], + 'Code' => [ + 'description' => '状态码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '获取所有正常实例', + ], + 'InstallManagedPrometheus' => [ + 'summary' => '创建托管（ASK/ECS）Prometheus。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '118951', + 'abilityTreeNodes' => [ + 'FEATUREarmsC7S24K', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ClusterType为ask时，必填', + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例的资源组id', + 'description' => 'Prometheus实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '仅ClusterType为“ecs”时生效：ecs实例的名称', + 'description' => '集群名称。ClusterType为ecs时，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'prd-ecs', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '可选值：ask、ecs、one、acs、pro、flink', + 'description' => '集群类型。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'flink' => 'flink', + 'ecs' => 'ecs', + 'one' => 'one', + 'ask' => 'ask', + 'pro' => '容器监控pro', + ], + 'example' => 'ask', + 'enum' => [ + 'ecs', + 'ask', + 'one', + 'acs', + 'pro', + 'flink', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '集群所对应的VPC。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-xxxxxx', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所对应的交换机。', + 'type' => 'string', + 'required' => true, + 'example' => 'vsw-bp1*********', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群所对应的安全组。', + 'type' => 'string', + 'required' => true, + 'example' => 'sg-bp1********', + ], + ], + [ + 'name' => 'GrafanaInstanceId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '绑定托管版Grafana工作区Id。为空或“free”时，表示绑定到“共享版Grafana”。', + 'description' => '集群绑定的托管版Grafana工作区Id。为空或"free"时，绑定到共享版Grafana。', + 'type' => 'string', + 'required' => false, + 'example' => 'grafana-bp1*****', + 'default' => 'free', + ], + ], + [ + 'name' => 'KubeConfig', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '当前参数不支持使用。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '-', + 'default' => 'kubeConfig', + ], + ], + [ + 'name' => 'VcExtraInfo', + 'in' => 'query', + 'schema' => [ + 'description' => 'flink VC集群扩展信息。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'String 2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Data' => [ + 'description' => '响应内容。通常返回安装状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否安装成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '安装失败时响应描述。', + 'type' => 'string', + 'example' => 'vpcId is blank', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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\\": \\"String\\\\t2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Data\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"vpcId is blank\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => '创建托管Prometheus', + 'description' => '只适用于ASK和ECS实例，且集群未安装过阿里云Prometheus，托管Prometheus将被安装在云产品侧，用户集群中不可见。', + ], + 'UninstallManagedPrometheus' => [ + 'summary' => '卸载托管（ASK/ECS/ACKoNE）Prometheus。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '119001', + 'abilityTreeNodes' => [ + 'FEATUREarmsC7S24K', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ClusterType为“ask”时，必填。', + 'description' => '阿里云容器服务Kubernetes版的Kubernetes集群的ID。ClusterType为ask或one时，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例的资源组id', + 'description' => 'prometheus实例的资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '可选值：ask、ecs、one、acs、flink', + 'description' => '集群类型。包括 ask、ecs和one。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'ecs' => 'ecs', + 'one' => 'one', + 'ask' => 'ask', + ], + 'example' => 'ask', + 'enum' => [ + 'ecs', + 'ask', + 'one', + 'acs', + 'flink', + ], + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '集群所对应的VPC。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-rpn**********', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '响应结果对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Data' => [ + 'description' => '响应内容。通常返回安装状态。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '是否卸载成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '失败时返回的响应描述。', + 'type' => 'string', + 'example' => 'vpcId is blank', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Data\\": \\"success\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"vpcId is blank\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => '卸载托管Prometheus', + 'description' => '只适用于ASK、ECS和ACKOne集群，集群已安装过托管版Prometheus。', + ], + 'GetManagedPrometheusStatus' => [ + 'summary' => '获取托管版（ask、ecs和one）Prometheus实例的安装状态。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ClusterType为“ask”时，必填。', + 'description' => '集群ID。ClusterType为ask或one时，必填。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例的资源组id', + 'description' => 'prometheus实例的资源组id。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'ClusterType', + 'in' => 'query', + 'schema' => [ + 'title' => '可选值：ask、ecs、one、acs', + 'description' => '集群类型。目前支持ask、acs、ecs和one实例。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'acs' => 'acs', + 'ecs' => 'ecs', + 'one' => 'one', + 'ask' => 'ask', + ], + 'example' => 'ask', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'title' => 'ClusterType为“ecs”时，必填。', + 'description' => 'ClusterType为“ecs”时，必填。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-***', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回消息格式。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Data' => [ + 'description' => '查询状态结果。'."\n" + .'- Installing：install成功且无Agent注册信息。'."\n" + .'- Succeed：install成功且Agent注册成功。'."\n" + .'- Failure：install失败或Agent注册失败。'."\n" + .'- Unknown： 无install状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Unknown' => 'Unknown', + 'Installing' => 'Installing', + 'Failure' => 'Failure', + 'Succeed' => 'Succeed', + ], + 'example' => 'Installing', + ], + 'Success' => [ + 'description' => '是否操作成功。'."\n" + ."\n" + .'- `true`删除成功'."\n" + .'- `false`删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '请求失败的提示信息。', + 'type' => 'string', + 'example' => '查询成功', + ], + 'Code' => [ + 'description' => '接口状态或pop错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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\\": \\"F7781D4A-2818-41E7-B7BB-79D809E9****\\",\\n \\"Data\\": \\"Installing\\",\\n \\"Success\\": true,\\n \\"Message\\": \\"查询成功\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => '获取托管版Prometheus安装状态', + ], + 'BindPrometheusGrafanaInstance' => [ + 'summary' => '绑定Prometheus实例使用的Grafana工作区ID。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例Id', + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例的资源组id', + 'description' => 'Prometheus实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'GrafanaInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'grafana工作区id', + 'description' => 'Grafana工作区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grafana-bp1*****', + ], + ], + ], + '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' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + 'Data' => [ + 'title' => '操作是否成功', + 'description' => '操作是否成功。'."\n" + ."\n" + .'- true：成功'."\n" + .'- false：失败', + 'type' => 'boolean', + 'enumValueTitles' => [ + 'true' => '成功', + 'false' => '失败', + ], + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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被标记为弃用。', + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Data\\": true,\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => '绑定Prometheus实例使用的Grafana工作区ID', + ], + 'AddPrometheusIntegration' => [ + 'summary' => '增加Prometheus实例的集成中心Exporter实例（仅支持aliyun-cs、ecs两种类型的实例）。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'prometheus实例Id。仅支持aliyun-cs、ecs两种类型的实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => [ + 'title' => 'Prometheus集成类型', + 'description' => '集成类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'kafka、mysql、redis、snmp、emr、nubela、tidb等', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'title' => 'Prometheus集成配置参数json串', + 'description' => '集成exporter的配置json串。', + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '3703B98C-335E-5BA7-972E-F90E9E768A85', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'Prometheus实例的集成Exporter实例id。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2829', + ], + 'InstanceName' => [ + 'title' => 'prometheus集成的实例名', + 'description' => 'prometheus集成的Exporter实例名。', + 'type' => 'string', + 'example' => 'hw-cloud02', + ], + ], + ], + 'Code' => [ + 'description' => '接口状态或pop错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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\\": \\"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' => '增加Prometheus实例的集成中心Exporter实例', + ], + 'UpdatePrometheusIntegration' => [ + 'summary' => '更改Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）集成中心Exporter配置。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。仅支持aliyun-cs、ecs两种类型的实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'Param', + 'in' => 'query', + 'schema' => [ + 'title' => 'Prometheus集成配置参数json串', + 'description' => '集成Exporter的配置json串。', + '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' => '集成中心Exporter实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2893', + ], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus集成类型', + 'description' => '集成类型。', + 'type' => 'string', + 'required' => true, + 'example' => 'kafka、mysql、redis、snmp、emr、nubela、tidb等。', + ], + ], + ], + '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' => '2DB771C3-D1BB-5363-8A5F-ADB2AF2948DB', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'InstanceId' => [ + 'description' => 'Prometheus实例的集成Exporter实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2866', + ], + 'InstanceName' => [ + 'title' => 'prometheus集成的实例名', + 'description' => 'prometheus集成的实例名。', + 'type' => 'string', + 'example' => 'inet', + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => '查询成功', + ], + 'Code' => [ + 'description' => '接口状态或pop错误码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '更改Prometheus实例集成中心Exporter配置', + ], + 'DeletePrometheusIntegration' => [ + 'summary' => '删除Prometheus实例集成中心Exporter实例（仅支持aliyun-cs、ecs两种类型的实例）。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。仅支持aliyun-cs、ecs两种类型的实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus集成类型，如kafka、mysql', + 'description' => 'prometheus集成类型，如kafka、mysql。', + 'type' => 'string', + 'required' => true, + 'example' => 'kafka、mysql等。', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例集成中心Exporter实例id', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2875', + ], + ], + ], + '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' => '19F54318-CC92-5567-BF66-CB029EC44C84', + ], + 'Data' => [ + 'title' => '”success“或失败信息。', + 'description' => '”success“或失败信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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\\": \\"19F54318-CC92-5567-BF66-CB029EC44C84\\",\\n \\"Data\\": \\"success\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200\\n}","type":"json"}]', + 'title' => '删除Prometheus实例集成中心Exporter实例', + ], + 'GetPrometheusIntegration' => [ + 'summary' => '获取Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）指定集成中心Exporter实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。仅支持aliyun-cs和ecs两种类型的实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => [ + 'title' => 'Prometheus集成类型', + 'description' => '集成类型：kafka、mysql、redis、snmp、emr、nubela、tidb等。', + 'type' => 'string', + 'required' => true, + 'example' => 'tidb', + ], + ], + [ + 'name' => 'InstanceId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例集成中心Exporter实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '28**', + ], + ], + ], + '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' => '9BEF2832-9D95-5E3E-9B10-74887C******', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'title' => '', + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + 'InstanceId' => [ + 'description' => 'Prometheus实例的集成Exporter实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '28**', + ], + 'ShowDescribe' => [ + 'description' => '是否展示描述。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NeedUpgrade' => [ + 'description' => '是否需要升级。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'InstanceName' => [ + 'description' => 'Prometheus集成的Exporter实例名。', + 'type' => 'string', + 'example' => 'lpd-skyeye', + ], + 'IntegrationType' => [ + 'title' => '集成类型', + 'description' => '集成类型：kafka、mysql、redis、snmp、emr、nubela、tidb等。', + 'type' => 'string', + 'example' => 'tidb', + ], + 'ExporterType' => [ + 'title' => '集成类型', + 'description' => '集成Exporter类型。', + 'type' => 'string', + 'example' => 'tidb-exporter', + ], + 'Version' => [ + 'description' => '版本信息。', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Target' => [ + 'description' => '监控目标地址。', + 'type' => 'string', + 'example' => '127.0.XX.XX:3422', + ], + 'CanDelete' => [ + 'description' => '是否能删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CanEditor' => [ + 'description' => '是否可以编辑。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => 'Exporter状态', + 'type' => 'string', + 'example' => 'installed', + ], + 'Describe' => [ + 'description' => 'Exporter描述。', + 'type' => 'string', + 'example' => '"{}"', + ], + 'ShowLog' => [ + 'description' => '是否展示Exporter日志。', + 'type' => 'string', + 'example' => 'true', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'kafka-exporter-1', + ], + 'Param' => [ + 'title' => 'exporter配置参数json串', + 'description' => 'Exporter配置参数JSON串。', + '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" + .'}', + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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\\": \\"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' => '获取Prometheus实例指定集成中心Exporter实例', + ], + 'ListPrometheusIntegration' => [ + 'summary' => '查询Prometheus实例（仅支持aliyun-cs、ecs两种类型的实例）集成中心Exporter实例列表。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => true, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。仅支持aliyun-cs和ecs两种类型的实例。', + 'type' => 'string', + 'required' => true, + 'example' => 'c77f6f2397ea74672872acf5e31******', + ], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => [ + 'description' => '集成类型：kafka、mysql、redis、snmp、emr、nubela、tidb等。', + 'type' => 'string', + 'required' => true, + 'example' => 'kafka', + ], + ], + ], + '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' => '1F1D8840-5330-5804-A8DB-C3C5C5******', + ], + 'Data' => [ + 'description' => '返回结构体数组。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'c77f6f2397ea74672872acf5e31******', + ], + 'ShowDescribe' => [ + 'description' => '是否展示描述。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'NeedUpgrade' => [ + 'description' => '是否需要升级。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'InstanceName' => [ + 'description' => 'Prometheus集成的Exporter实例名。', + 'type' => 'string', + 'example' => 'inet', + ], + 'ExporterType' => [ + 'description' => '集成Exporter类型。', + 'type' => 'string', + 'example' => 'kafka-exporter', + ], + 'IntegrationType' => [ + 'description' => '集成类型：kafka、mysql、redis、snmp、emr、nubela、tidb等。', + 'type' => 'string', + 'example' => 'kafka', + ], + 'InstanceId' => [ + 'description' => 'Prometheus实例的集成Exporter实例ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '293**', + ], + 'Version' => [ + 'description' => '版本信息。', + 'type' => 'string', + 'example' => '1.0.0', + ], + 'Target' => [ + 'description' => '监控目标地址。', + 'type' => 'string', + 'example' => '121.40.XX.XX:3342', + ], + 'CanDelete' => [ + 'description' => '是否能删除。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CanEditor' => [ + 'description' => '是否可以编辑。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Status' => [ + 'description' => 'Exporter实例状态。', + 'type' => 'string', + 'example' => 'installed', + ], + 'ContainerName' => [ + 'description' => '容器名称。', + 'type' => 'string', + 'example' => 'container-1', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + 'PodName' => [ + 'description' => 'Exporter Pod名。', + 'type' => 'string', + 'example' => 'kafka-exporter-1', + ], + 'Describe' => [ + 'description' => 'Exporter描述。', + 'type' => 'string', + 'example' => '"{}"', + ], + 'ShowLog' => [ + 'description' => '是否展示Exporter日志。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Param' => [ + 'title' => 'exporter配置参数json串', + 'description' => 'Exporter配置参数JSON串。', + '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" + .'}', + ], + ], + ], + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '查询Prometheus实例集成中心Exporter实例列表', + ], + 'GetPrometheusInstance' => [ + 'summary' => '获取指定Prometheus实例信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '163198', + 'abilityTreeNodes' => [ + 'FEATUREarmsFRX7PL', + ], + 'tenantRelevance' => 'tenant', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'c77f6f2397ea74672872acf5e31374a27', + ], + ], + ], + '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' => '52C422FD-6B43-524D-B8A1-A4693294318C', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'c589a1b8db05c4561aefbb898ca8fb1cf', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-beijing', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '167275301789****', + ], + 'ClusterName' => [ + 'description' => '集群名称。', + '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（Prometheus for 通用）'."\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 容器服务）', + 'type' => 'string', + 'example' => 'remote-write', + ], + 'VpcId' => [ + 'description' => '集群所对应的VPC。（仅Prometheus for ECS透出）', + 'type' => 'string', + 'example' => 'vpc-8vb02uk57qbcktqcvqqqj', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。（仅Prometheus for ECS透出）', + 'type' => 'string', + 'example' => 'vsw-f8z73vcja1tqnw90aav5a', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID。（仅Prometheus for ECS透出）', + 'type' => 'string', + 'example' => 'sg-8vbdgmf4nraiqa9bx0jo', + ], + 'SubClustersJson' => [ + 'title' => 'globalView实例的子实例json串', + 'description' => 'globalView实例的子实例JSON串。', + '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' => 'remote read内网地址', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', + ], + 'RemoteReadInterUrl' => [ + 'description' => 'remote read公网地址', + 'type' => 'string', + 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', + ], + 'RemoteWriteIntraUrl' => [ + 'description' => 'remote write内网地址', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write', + ], + 'RemoteWriteInterUrl' => [ + 'description' => 'remote write公网地址', + 'type' => 'string', + 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write', + ], + 'PushGatewayIntraUrl' => [ + 'description' => 'push gateway内网地址', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2', + ], + 'PushGatewayInterUrl' => [ + 'description' => 'push gateway公网地址', + 'type' => 'string', + 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2', + ], + 'OpenTelemetryInterUrl' => [ + 'type' => 'string', + ], + 'HttpApiIntraUrl' => [ + 'description' => 'http api内网地址', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx', + ], + 'HttpApiInterUrl' => [ + 'description' => 'http api公网地址', + 'type' => 'string', + 'example' => 'https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx', + ], + 'AuthToken' => [ + 'description' => '授权token串', + 'type' => 'string', + 'example' => 'GciOiJIUzI1NiJ9***', + ], + 'AccessType' => [ + 'title' => '权限类型：'."\n" + .'readWrite、readOnly、httpReadOnly', + 'description' => '权限类型：'."\n" + .'readWrite、readOnly、httpReadOnly', + 'type' => 'string', + 'example' => 'readWrite', + ], + 'PaymentType' => [ + 'description' => '付费类型。'."\n" + ."\n" + .'- PREPAY-包年包月'."\n" + .'- POSTPAY-按量付费', + 'type' => 'string', + 'example' => 'PREPAY', + ], + 'StorageDuration' => [ + 'title' => '存储时长（天）。', + 'description' => '存储时长（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '90', + ], + 'ArchiveDuration' => [ + 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存，3650表示永久保存。', + 'description' => '存储到期后，自动归档保存的天数（可选值：60、90、180、365）。0表示不归档保存。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '60', + ], + 'GrafanaInstanceId' => [ + 'description' => 'Grafana工作区ID。', + 'type' => 'string', + 'example' => 'grafana-rnggfvhlcdl6m71***', + ], + 'ResourceGroupId' => [ + 'description' => '实例所属的资源组ID。', + 'type' => 'string', + 'example' => 'rg-aek2vezare****', + ], + 'ResourceType' => [ + 'title' => '固定值：PROMETHEUS', + 'description' => '固定值：PROMETHEUS。', + 'type' => 'string', + 'example' => 'PROMETHEUS', + ], + 'EnableAuthToken' => [ + 'title' => '是否开启访问Token鉴权', + 'description' => '是否开启访问Token鉴权', + 'type' => 'string', + 'example' => 'true', + ], + 'SupportAuthTypes' => [ + 'description' => '支持的认证鉴权类型。', + 'type' => 'array', + 'items' => [ + 'description' => '支持的认证鉴权类型。', + 'type' => 'string', + 'enumValueTitles' => [ + 'BasicAuth' => 'http基础鉴权', + 'AuthFree' => '免密', + 'AuthToken' => 'token鉴权', + ], + 'example' => 'AuthFree', + ], + ], + 'EnableAuthFreeRead' => [ + 'title' => '是否开启读免密。', + 'description' => '是否开启读免密。', + 'type' => 'boolean', + ], + 'AuthFreeReadPolicy' => [ + 'title' => '读免密地址白名单策略。', + 'description' => '读免密地址白名单策略。', + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + 'EnableAuthFreeWrite' => [ + 'title' => '是否开启写免密。', + 'description' => '是否开启写免密。', + 'type' => 'boolean', + ], + 'AuthFreeWritePolicy' => [ + 'title' => '写免密地址白名单策略。', + 'description' => '写免密地址白名单策略。', + 'type' => 'string', + 'example' => '0.0.0.0/0', + ], + 'Product' => [ + 'title' => 'prom实例归属的产品（arms或cms）', + 'description' => 'prom实例归属的产品（arms或cms）', + 'type' => 'string', + 'example' => 'arms', + ], + 'DbInstanceStatus' => [ + 'title' => '后端数据存储状态', + 'description' => '后端数据存储状态', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'Version' => [ + 'title' => '版本', + 'description' => '版本', + 'type' => 'string', + 'example' => 'V1', + ], + 'PaymentTypeUpdateTime' => [ + 'title' => '实例计费方式修改时间', + 'description' => '实例计费方式修改时间', + 'type' => 'string', + 'example' => '2025-02-26T06:05:01Z', + ], + 'ExtraInfo' => [ + 'title' => '扩展信息（仅控制台请求才返回）', + 'description' => '扩展信息（仅控制台请求才返回）', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '扩展信息。', + 'example' => 'extraKey', + ], + ], + 'Tags' => [ + 'description' => '实例所绑定的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'tag1', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'tagValue1', + ], + ], + ], + ], + 'OpenTelemetryIntraUrl' => [ + 'type' => 'string', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取指定Prometheus实例信息', + ], + 'ListPrometheusInstanceByTagAndResourceGroupId' => [ + 'summary' => '根据标签和资源组查询Prometheus实例。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '资源的标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'fpx-tag', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'fvt-tag-value', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + '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' => '4789C3E9-A85A-524B-B97B-9D2B14BA06BC', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PrometheusInstances' => [ + 'description' => 'Prometheus实例列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClusterId' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'c9d5dda1aeca64220853ace304baeb03d', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-shanghai', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '1672753017899***', + ], + 'ClusterName' => [ + 'description' => 'Prometheus实例名。', + '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（Prometheus for Remote Write）'."\n" + ."\n" + .'- 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 容器服务）', + 'type' => 'string', + 'example' => 'ecs', + ], + 'VpcId' => [ + 'description' => 'VPC ID。', + 'type' => 'string', + 'example' => 'vpc-8vbtp1fsm8mir18l8rl0u', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-f8z73vcja1tqnw90aav5a', + ], + 'SecurityGroupId' => [ + 'description' => '安全组ID。', + 'type' => 'string', + 'example' => 'sg-f8zd1toc10wmbi1v5rom', + ], + 'SubClustersJson' => [ + 'title' => 'globalView实例的子实例json串', + 'description' => 'globalView实例的子实例json串。', + 'type' => 'string', + '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' => 'Remote Read内网地址。', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', + ], + 'RemoteReadInterUrl' => [ + 'description' => 'Remote Read公网地址。', + 'type' => 'string', + 'example' => 'http://cn-beijing.arms.aliyuncs.com:9090/api/v1/prometheus/xxx/api/v1/read', + ], + 'RemoteWriteIntraUrl' => [ + 'description' => 'Remote Write内网地址。', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v3/write', + ], + 'RemoteWriteInterUrl' => [ + 'description' => 'Remote Write公网地址。', + 'type' => 'string', + 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v3/write', + ], + 'PushGatewayIntraUrl' => [ + 'description' => 'Push Gateway内网地址。', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com/prometheus/xxx/api/v2', + ], + 'PushGatewayInterUrl' => [ + 'description' => 'Push Gateway公网地址。', + 'type' => 'string', + 'example' => 'https://cn-beijing.arms.aliyuncs.com/prometheus/xxx/api/v2', + ], + 'HttpApiIntraUrl' => [ + 'description' => 'HTTP API内网地址。', + 'type' => 'string', + 'example' => 'http://cn-beijing-intranet.arms.aliyuncs.com:9090/api/v1/prometheus/xxx'."\n", + ], + 'HttpApiInterUrl' => [ + 'description' => 'HTTP API公网地址。', + 'type' => 'string', + 'example' => 'https://cn-beijing.arms.aliyuncs.com:9443/api/v1/prometheus/xxx', + ], + 'AuthToken' => [ + 'description' => '授权Token串。', + 'type' => 'string', + 'example' => 'GciOiJIUzI1NiJ9***', + ], + 'PaymentType' => [ + 'description' => '付费类型。'."\n" + ."\n" + .'- PREPAY-包年包月'."\n" + .'- POSTPAY-按量付费', + 'type' => 'string', + 'example' => 'POSTPAY', + ], + 'GrafanaInstanceId' => [ + 'description' => 'Grafana工作区ID。', + 'type' => 'string', + 'example' => 'grafana-rnggfvhlcdl6m71l**', + ], + 'ResourceGroupId' => [ + 'description' => 'Prometheus实例的资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmz7nocpeidcy', + ], + 'ResourceType' => [ + 'description' => '资源类型', + 'type' => 'string', + 'example' => 'PROMETHEUS', + ], + 'Tags' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '实例的标签值。', + 'type' => 'object', + 'properties' => [ + 'TagKey' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'ac-cus-tag-3', + ], + 'TagValue' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'asg-2vc8qq7x89o11rus9uvu', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => '根据标签和资源组查询Prometheus实例', + ], + 'CreatePrometheusInstance' => [ + 'summary' => '新建Prometheus实例。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'abilityTreeCode' => '165691', + 'abilityTreeNodes' => [ + 'FEATUREarmsFRX7PL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '国内Prometheus for 云服务：固定值cn-shanghai。'."\n" + .'其它类型的实例：实际regionId。', + 'description' => '实际Region。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shanghai', + ], + ], + [ + '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' => '类型有： '."\n" + .'- remote-write：Prometheus for Remote Write'."\n" + .'- ecs（不再支持）：Prometheus for ECS'."\n" + .'- global-view：Prometheus for GlobalView'."\n" + .'- aliyun-cs（不再支持）：Prometheus for 容器服务'."\n" + .'- cloud-product（不再支持）：Prometheus for 云服务'."\n" + .'- cloud-monitor（不再支持）：Prometheus for 企业云监控'."\n" + .'- flink（不再支持）: Prometheus for Flink', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'remote-write', + ], + ], + [ + 'name' => 'VpcId', + 'in' => 'query', + 'schema' => [ + 'title' => '当clusterType为ecs或者创建托管版ask容器集群时，需要传此参数：用户专有网络VPC', + 'description' => '用户专有网络VPC。当clusterType为ecs或者aliyun-cs的托管版ask容器集群时，需要传此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-rpn**********', + ], + ], + [ + 'name' => 'VSwitchId', + 'in' => 'query', + 'schema' => [ + 'title' => '当clusterType为ecs或者创建托管版ask容器集群时，需要传此参数：用户专有网络交换机VSwitch', + 'description' => '用户专有网络交换机VSwitch。当clusterType为ecs或者aliyun-cs的托管版ask容器集群时，需要传此参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'vsw-bp1*********', + ], + ], + [ + 'name' => 'SecurityGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '当clusterType为ecs或者创建托管版ask容器集群时，需要传此参数：用户专有网络安全组SecurityGroup', + 'description' => '用户专有网络安全组SecurityGroup。当clusterType为ecs或者aliyun-cs的托管版ask容器集群时，需要传此参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'sg-bp1********', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'title' => '当clusterType为aliyun-cs时，需要传此参数：用户容器服务集群ID', + 'description' => '用户容器服务集群ID。当clusterType为aliyun-cs时，需要传此参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + [ + 'name' => 'ClusterName', + 'in' => 'query', + 'schema' => [ + 'title' => '当clusterType为remote-write、ecs、global-view时，需要传此参数：用户新建集群的名称。'."\n" + .'ecs类型实例时，ClusterName的命名规则“name-vpc-id”，且name长度不允许超过24个字符。如“mytest1-vpc-xxxxxxxxxxx”。', + 'description' => '用户新建集群的名称。当clusterType为remote-write、ecs、global-view时，需要传此参数。'."\n" + ."\n" + .'若是ecs类型实例，ClusterName的命名规则为“name-vpc-id”，且name部分的长度不允许超过24个字符，例如“mytest1-vpc-xxxxxxxxxxx”。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'clusterNameOfTest', + ], + ], + [ + 'name' => 'SubClustersJson', + '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' => 'globalView实例的子实例JSON串。', + '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' => '创建GlobalView时，是否要求所有子实例都校验成功时，才创建GlobalView实例。后台默认是false，即可以部分成功。', + 'description' => '创建GlobalView时，是否要求所有子实例都校验成功时，才创建GlobalView实例。默认是false，即可以部分成功。', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GrafanaInstanceId', + 'in' => 'query', + 'schema' => [ + 'title' => 'Grafana工作区ID；共享版Grafana时，填"free"。', + 'description' => '绑定的Grafana工作区ID。使用共享版Grafana时，值为“free”。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'grafana-bp1*****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '用户资源组ID', + 'description' => '资源组ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'title' => '可以传此参数，给实例创建标签进行管理', + 'description' => '用户自定义标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '标签名', + 'description' => '标签的键（Key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'title' => '标签值', + 'description' => '标签的值（Value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'example' => '['."\n" + .' {'."\n" + .' "labelName":"labelValue"'."\n" + .' },'."\n" + .' {'."\n" + .' "testName":"clusterA"'."\n" + .' }'."\n" + .']', + 'maxItems' => 21, + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'title' => '存储时长（天）。', + 'description' => '数据存储时长（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'ArchiveDuration', + 'in' => 'query', + 'schema' => [ + 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" + .'V1：60、90、180、365天。'."\n" + .'V2：1~3650天（3650表示永久保存）。', + 'description' => '存储到期后，自动归档保存的天数（可选值：60、90、180、365）。0表示不归档保存。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => [ + 'title' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。'."\n" + .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', + 'description' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。'."\n" + .'空：则使用用户的默认计费方式配置。若用户未配置默认值，则系统默认是按指标上报量计费。', + 'type' => 'string', + 'required' => false, + 'example' => 'POSTPAY', + 'enum' => [ + 'POSTPAY', + 'POSTPAY_GB', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'title' => '集群id', + 'description' => '新建实例成功后的实例ID。'."\n" + ."\n" + .'- 如果是aliyun-cs实例，则Prometheus实例ID就是CS的集群ID。'."\n" + ."\n" + .'- 如果是ecs实例，则Prometheus实例ID就是VPCID。', + 'type' => 'string', + 'example' => 'qduukd****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70675725-8F11-4817-8106-CFE0AD71****', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '接口状态码：'."\n" + ."\n" + .'- `2XX`：成功'."\n" + .'- `3XX`：重定向'."\n" + .'- `4XX`：请求错误'."\n" + .'- `5XX`：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '新建Prometheus实例', + ], + 'UpdatePrometheusInstance' => [ + 'summary' => '更新Prometheus实例信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '217860', + 'abilityTreeNodes' => [ + 'FEATUREarmsFRX7PL', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例的资源组id', + 'description' => 'Prometheus实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'title' => 'prometheus实例ID', + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'vpc-xxx', + ], + ], + [ + 'name' => 'StorageDuration', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '数据保存时长（天）。', + 'description' => '数据保存时长（天）。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'ArchiveDuration', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '存储到期后，自动归档保存的天数，0表示不归档保存。归档天数取值范围：'."\n" + .'V1：60、90、180、365天。'."\n" + .'V2：1~3650天（3650表示永久保存）。', + 'description' => '存储到期后，自动归档保存的天数（可选值：60、90、180、365）。0表示不归档保存。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '90', + ], + ], + [ + 'name' => 'EnableAuthToken', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否开启访问Token鉴权', + 'description' => '是否开启访问Token鉴权。', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'EnableAuthFreeRead', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否开启免密读', + 'description' => '是否开启免密读。', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'AuthFreeReadPolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否开启免密读的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', + 'description' => '是否开启免密读的IP地址列表，支持CIDR配置。多个IP之间换行符分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + ], + [ + 'name' => 'EnableAuthFreeWrite', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否开启免密写', + 'description' => '是否开启免密写。', + 'type' => 'boolean', + 'required' => false, + ], + ], + [ + 'name' => 'AuthFreeWritePolicy', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'title' => '是否开启免密写的ip地址列表，支持CIDR配置。多个ip之间换行符分隔。', + 'description' => '是否开启免密写的IP地址列表，支持CIDR配置。多个IP之间换行符分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '0.0.0.0/0', + ], + ], + [ + 'name' => 'PaymentType', + 'in' => 'query', + 'schema' => [ + 'title' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。', + 'description' => '计费方式：'."\n" + .'POSTPAY：按指标上报量后付费。'."\n" + .'POSTPAY_GB：按指标写入量后付费。', + 'type' => 'string', + 'required' => false, + 'example' => 'POSTPAY', + 'enum' => [ + 'POSTPAY', + 'POSTPAY_GB', + ], + ], + ], + ], + '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' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', + ], + 'Data' => [ + 'description' => '操作结果描述。', + 'type' => 'string', + 'example' => 'success', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + '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' => '更新Prometheus实例信息', + ], + 'UpdatePrometheusGlobalView' => [ + 'summary' => '更新Prometheus for GlobalView聚合数据源。', + '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' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-shenzhen', + ], + ], + [ + 'name' => 'GroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'zyGlobalView', + ], + ], + [ + 'name' => 'MostRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '聚合实例所属地域ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'global****', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => 'prometheus实例的资源组id', + 'description' => 'Prometheus实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'SubClustersJson', + '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' => '需要聚合的Ali Prometheus集群或数据源的信息列表。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + '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' => [ + 'title' => '创建GlobalView时，是否要求所有子实例都校验成功时，才创建GlobalView实例。后台默认是false，即可以部分成功。', + 'description' => '创建GlobalView时，是否要求所有子实例都校验成功时，才创建GlobalView实例。默认是false，即可以部分成功。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '更新是否成功。'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'FailedInstances' => [ + 'description' => '更新失败的集群或数据源列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'SourceName' => [ + 'description' => '数据源名称。', + 'type' => 'string', + 'example' => 'sourcename-test', + ], + 'SourceType' => [ + 'title' => 'AlibabaPrometheus'."\n" + .'MetricStore'."\n" + .'CustomPrometheus', + 'description' => '数据源类型：'."\n" + ."\n" + .'- AlibabaPrometheus'."\n" + .'- MetricStore'."\n" + .'- CustomPrometheus', + 'type' => 'string', + 'example' => 'AlibabaPrometheus', + ], + 'UserId' => [ + 'description' => '用户标识。', + 'type' => 'string', + 'example' => '23784673825*******', + ], + 'ClusterId' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'example' => 'cdb65ed2d527345*********', + ], + ], + ], + ], + ], + ], + 'RequestId' => [ + 'description' => '请求ID，用于定位日志，排查问题。', + 'type' => 'string', + 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', + ], + 'Message' => [ + 'description' => '安装失败时响应描述。', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '状态码。说明200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'noSubstitutionReason' => '无替代API，历史原因导致该API被标记为弃用。', + 'returnType' => 'synchronous', + ], + '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' => '更新Prometheus for GlobalView聚合数据源', + ], + 'ListEnvironmentKubeResources' => [ + 'summary' => '查看环境的K8s资源。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '195018', + 'abilityTreeNodes' => [ + 'FEATUREarmsC7S24K', + ], + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Kind', + 'in' => 'query', + 'schema' => [ + 'title' => '资源kind Pod | Deployment | Service ...等', + 'description' => '资源Kind Pod | Deployment | Service 等。', + 'type' => 'string', + 'required' => true, + 'example' => 'Pod', + ], + ], + [ + 'name' => 'Namespace', + 'in' => 'query', + 'schema' => [ + 'title' => '命名空间', + 'description' => '命名空间。', + 'type' => 'string', + 'required' => false, + 'example' => 'default', + ], + ], + [ + 'name' => 'LabelSelectors', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '标签选择', + 'description' => '标签选择。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"app":"mysql"}', + 'description' => '标签。', + ], + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功。'."\n" + .'- `false`：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ApiVersion' => [ + 'description' => 'API版本号。', + 'type' => 'string', + 'example' => 'v1', + ], + 'Kind' => [ + 'description' => 'K8s资源Kind。', + 'type' => 'string', + 'example' => 'Pod', + ], + 'Metadata' => [ + 'description' => '元数据。', + 'type' => 'object', + 'properties' => [ + 'Annotations' => [ + 'description' => '注释列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => ' {'."\n" + .' "kubernetes.io/psp": "ack.privileged",'."\n" + .' "k8s.aliyun.com/pod-ips": "172.16.0.188"'."\n" + .' }', + 'description' => '注释列表。', + ], + ], + 'Labels' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '标签列表。', + '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' => '资源名称。', + 'type' => 'string', + 'example' => 'arms-prometheus-ack-arms-prometheus-c577b6cc8-mvdwd', + ], + 'Namespace' => [ + 'description' => '命名空间。', + 'type' => 'string', + 'example' => 'arms-prom', + ], + ], + ], + 'Spec' => [ + 'description' => '资源Spec。', + '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' => '资源状态。', + 'type' => 'any', + 'example' => 'run', + ], + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查看环境的K8s资源', + ], + 'ListEnvironmentMetricTargets' => [ + 'summary' => '查询环境中的Target列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '194431', + 'abilityTreeNodes' => [ + 'FEATUREarmsC7S24K', + ], + ], + 'parameters' => [ + [ + 'name' => 'EnvironmentId', + 'in' => 'query', + 'schema' => [ + 'title' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'JobName', + 'in' => 'query', + 'schema' => [ + 'title' => 'job名称', + 'description' => 'Job名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'blackbox', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ActiveTargets' => [ + 'description' => '正常的Target。', + 'type' => 'array', + 'items' => [ + 'description' => 'Target信息', + 'type' => 'object', + 'properties' => [ + 'DiscoveredLabels' => [ + 'description' => '服务发发现的标签。', + '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' => '标签值。', + ], + ], + 'GlobalUrl' => [ + 'description' => 'Target的URL。', + 'type' => 'string', + 'example' => 'http://xxx', + ], + 'Health' => [ + 'description' => '健康状态。', + 'type' => 'string', + 'example' => 'up', + ], + 'Labels' => [ + 'description' => '标签。', + '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' => '标签的值。', + ], + ], + 'LastError' => [ + 'description' => '最后一次错误信息。', + 'type' => 'string', + 'example' => 'Get \\"http://172.16.0.86:9104/metrics\\": dial tcp 172.16.0.86:9104: connect: connection refused', + ], + 'LastScrape' => [ + 'description' => '最后一次采集时间。', + 'type' => 'string', + 'example' => '2023-10-12T07:15:47.306691514Z', + ], + 'LastScrapeDuration' => [ + 'description' => '最后一次采集持续时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => ' 0.00127593', + ], + 'LastScrapeSeries' => [ + 'description' => '最后一次采集的指标量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122', + ], + 'ScrapePool' => [ + 'description' => '采集名。', + 'type' => 'string', + 'example' => 'arms-prom/mysql-exporter-mysql-1694429267986-sm/0"', + ], + 'ScrapeUrl' => [ + 'description' => '采集的地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + ], + ], + ], + 'DroppedTargets' => [ + 'description' => '删除的Target集合。', + 'type' => 'array', + 'items' => [ + 'description' => 'Target信息。', + 'type' => 'object', + 'properties' => [ + 'DiscoveredLabels' => [ + 'description' => '服务发发现的标签。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '标签值。', + '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' => 'Target的URL。', + 'type' => 'string', + 'example' => 'http://xxx', + ], + 'Health' => [ + 'description' => '健康状态。', + 'type' => 'string', + 'example' => 'up', + ], + 'Labels' => [ + 'description' => '标签。', + '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' => '标签的值。', + ], + ], + 'LastError' => [ + 'description' => '最后一次错误信息。', + 'type' => 'string', + 'example' => 'Get \\"http://172.16.0.86:9104/metrics\\": dial tcp 172.16.0.86:9104: connect: connection refused', + ], + 'LastScrape' => [ + 'description' => '最后一次采集时间。', + 'type' => 'string', + 'example' => '2023-10-12T07:15:47.306691514Z', + ], + 'LastScrapeDuration' => [ + 'description' => '最后一次采集持续时间。', + 'type' => 'number', + 'format' => 'double', + 'example' => ' 0.00127593', + ], + 'LastScrapeSeries' => [ + 'description' => '最后一次采集的指标量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '122', + ], + 'ScrapePool' => [ + 'description' => '采集名。', + 'type' => 'string', + 'example' => 'arms-prom/mysql-exporter-mysql-1694429267986-sm/0"', + ], + 'ScrapeUrl' => [ + 'description' => '采集的地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询环境中的Target列表', + ], + 'ListEnvironmentAddons' => [ + 'summary' => '查询指定环境安装的Addon信息。', + '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' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + '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' => '操作是否成功：true：操作成功 false：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'Addons' => [ + 'description' => 'Addon列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'Addon信息。', + 'type' => 'object', + 'properties' => [ + 'Alias' => [ + 'description' => 'Addon别名。', + 'type' => 'string', + 'example' => 'MySQL', + ], + 'Categories' => [ + 'description' => 'Addon标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'cloud', + ], + ], + 'Dashboards' => [ + 'description' => '大盘列表。', + 'type' => 'array', + 'items' => [ + 'description' => '大盘信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'description' => '大盘描述。', + 'type' => 'string', + 'example' => 'MySQL监控大盘信息,监控了连接信息,使用信息等指标', + ], + 'Name' => [ + 'description' => '大盘名称。', + 'type' => 'string', + 'example' => 'mysql-overview', + ], + 'Url' => [ + 'description' => '大盘地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + ], + ], + ], + 'Description' => [ + 'description' => 'Addon描述信息。', + 'type' => 'string', + 'example' => '通过 MySQL Exporter 监控数据库指标', + ], + 'Environments' => [ + 'description' => '支持的环境列表。', + 'type' => 'array', + 'items' => [ + 'description' => '环境信息。', + 'type' => 'object', + 'properties' => [ + 'Dependencies' => [ + 'description' => '环境的依赖列表。', + 'type' => 'object', + 'properties' => [ + 'Features' => [ + 'description' => '环境可安装的Feature。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'boolean', + 'description' => '是否支持。', + 'example' => 'true', + ], + ], + 'Services' => [ + 'description' => '服务列表。', + 'type' => 'array', + 'items' => [ + 'description' => '服务名称。', + 'type' => 'string', + 'example' => 'ResourceCenter', + ], + ], + 'ClusterTypes' => [ + 'description' => '集群类型。', + 'type' => 'array', + 'items' => [ + 'description' => '集群类型。', + 'type' => 'string', + 'example' => 'Edge', + ], + ], + ], + ], + 'Description' => [ + 'description' => '环境描述信息。', + 'type' => 'string', + 'example' => 'MySQL 服务部署在 Kubernetes 集群中。', + ], + 'Enable' => [ + 'description' => '是否开启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Label' => [ + 'description' => '环境标签。', + 'type' => 'string', + 'example' => '容器环境', + ], + 'Name' => [ + 'description' => '环境名称。', + 'type' => 'string', + 'example' => 'CS', + ], + 'Policies' => [ + 'description' => '环境中的控制策略信息。', + 'type' => 'object', + 'properties' => [ + 'AlertDefaultStatus' => [ + 'description' => '默认告警状态。', + 'type' => 'string', + 'example' => 'default', + ], + 'DefaultInstall' => [ + 'description' => '默认安装状态。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TargetAddonName' => [ + 'description' => 'Addon的Target名称。', + 'type' => 'string', + 'example' => 'cloud-rds-mysql', + ], + 'Protocols' => [ + 'description' => '支持的协议列表。', + 'type' => 'array', + 'items' => [ + 'description' => '协议。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '协议名称。', + 'type' => 'string', + 'example' => 'arms', + ], + 'Icon' => [ + 'description' => '协议图标地址。', + 'type' => 'string', + 'example' => 'http://xxxxxxx', + ], + 'Label' => [ + 'description' => '协议标签。', + 'type' => 'string', + 'example' => 'ARMS', + ], + 'Description' => [ + 'description' => '协议描述。', + 'type' => 'string', + 'example' => 'ARMS', + ], + ], + ], + ], + 'MetricCheckRule' => [ + 'description' => '指标正常检查的规则。', + 'type' => 'object', + 'properties' => [ + 'PromQL' => [ + 'description' => 'PromQL查询语句。', + 'type' => 'array', + 'items' => [ + 'description' => 'PromQL查询语句。', + 'type' => 'string', + 'example' => 'max(flink_taskmanager_job_task_operator_currentEmitEventTimeLag{deploymentId=\'983d8f2d-14a9-4af0-a23d-751a7818c239\'}/1000) >= 600.0', + ], + ], + ], + ], + 'NeedRestartAfterIntegration' => [ + 'description' => '安装后是否需要重启。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'EnableServiceAccount' => [ + 'description' => '是否开启服务账户。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + 'Icon' => [ + 'description' => '图标地址。', + 'type' => 'string', + 'example' => 'http://xxxx', + ], + 'Keywords' => [ + 'description' => '关键字集合。', + 'type' => 'array', + 'items' => [ + 'description' => '关键字。', + 'type' => 'string', + 'example' => 'Java', + ], + ], + 'Language' => [ + 'description' => '语言。', + 'type' => 'string', + 'example' => 'zh', + ], + 'Name' => [ + 'description' => 'Addon名称。', + 'type' => 'string', + 'example' => 'mysql', + ], + 'Once' => [ + 'description' => '是否只能安装一次。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Scene' => [ + 'description' => '定位到的场景。', + 'type' => 'string', + 'example' => 'database', + ], + 'Version' => [ + 'description' => '插件版本。', + 'type' => 'string', + 'example' => '0.0.1', + ], + 'Weight' => [ + 'description' => '权重。', + 'type' => 'string', + 'example' => '857', + ], + 'LatestReleaseCreateTime' => [ + 'description' => '最后一次被创建时间。', + 'type' => 'string', + 'example' => '2023-09-22T16:56:29+08:00', + ], + ], + ], + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + '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' => '查询指定环境安装的Addon', + ], + 'ListEnvironmentAlertRules' => [ + 'summary' => '查询环境中的告警组信息。', + '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' => '环境id', + 'description' => '环境ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'env-xxx', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AddonName', + 'in' => 'query', + 'schema' => [ + 'title' => 'addon的名称,addonName和scene必填一个', + 'description' => 'Addon的名称，AddonName和Scene必填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'mysql', + ], + ], + [ + 'name' => 'Scene', + 'in' => 'query', + 'schema' => [ + 'title' => '场景,addonName和scene必填一个', + 'description' => '场景，AddonName和Scene必填一个。', + 'type' => 'string', + 'required' => false, + 'example' => 'database', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => 'response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '4C518054-852F-4023-ABC1-4AF95FF7****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Groups' => [ + 'description' => '告警组列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警组。', + 'type' => 'string', + 'example' => 'mysql-CS-MySQLdAlerts', + ], + ], + 'Rules' => [ + 'description' => '规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '规则。', + 'type' => 'object', + 'properties' => [ + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9502571', + ], + 'Name' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'mysql-CS-MySQLInnoDBLogWaits_lu', + ], + ], + ], + ], + 'Total' => [ + 'description' => '总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '26', + ], + ], + ], + ], + ], + ], + ], + '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' => '查询环境中的告警组信息', + ], + 'ListGrafanaWorkspace' => [ + 'summary' => '获取地域内Grafana工作区列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境，默认为中文：zh， 英文： en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema 返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '0080BE65-167F-5CB6-A691-14E2EFD474BC', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'array', + 'items' => [ + 'description' => 'Grafana工作区信息。', + '$ref' => '#/components/schemas/GrafanaWorkspace', + ], + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'TraceId' => [ + 'description' => '调用链ID，用于精确查询调用信息。', + 'type' => 'string', + 'example' => 'eac0a8048716731735000007137d000b', + ], + ], + ], + ], + ], + '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\\": \\"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' => '获取Grafana工作区列表', + 'description' => '说明：本接口返回列表包含开发者版、专家版、高级版 ，不包含共享版。', + ], + 'GetGrafanaWorkspace' => [ + 'summary' => '查询指定Grafana工作区信息。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GrafanaWorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作区 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grafana-cn-4xl3g******', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境，默认为中文：zh， 英文： en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + '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' => '2C3F217B-9AAE-5D51-974D-48********', + ], + 'Data' => [ + 'description' => 'Grafana工作区信息。', + '$ref' => '#/components/schemas/GrafanaWorkspace', + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '接口状态码：'."\n" + ."\n" + .'- `2XX`：成功'."\n" + .'- `3XX`：重定向'."\n" + .'- `4XX`：请求错误'."\n" + .'- `5XX`：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- `true`调用成功'."\n" + .'- `false`调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceId' => [ + 'description' => '调用链ID，用于精确查询调用信息。', + 'type' => 'string', + 'example' => 'eac0a8048716731735000007137d000b', + ], + ], + ], + ], + ], + '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\\": \\"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' => '查询Grafana工作区信息', + 'description' => '说明：本接口返回列表包含开发者版、专家版、高级版 ，不包含共享版。', + ], + 'CreateGrafanaWorkspace' => [ + 'summary' => '创建可观测可视化 Grafana 版工作区实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '164616', + 'abilityTreeNodes' => [ + 'FEATUREarmsRY7LT8', + ], + 'autoTest' => false, + 'notSupportAutoTestReason' => '涉及数据库任务，为了客户恢复需求，数据库资源不做释放，自动化调用资源浪费', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GrafanaWorkspaceName', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana工作区名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'testgrafana', + ], + ], + [ + 'name' => 'GrafanaWorkspaceEdition', + 'in' => 'query', + 'schema' => [ + 'description' => '版本。'."\n" + ."\n" + .'**枚举值：**'."\n" + .'- standard：内测版。'."\n" + .'- personal_edition：开发者版。'."\n" + .'- experts_edition：专家版。'."\n" + .'- advanced_edition：高级版。', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'experts_edition', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana工作区描述。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'GrafanaVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana版本。', + 'type' => 'string', + 'required' => true, + 'example' => '10.0.x', + ], + ], + [ + 'name' => 'Password', + 'in' => 'query', + 'schema' => [ + 'description' => '实例的密码。长度为8至30个字符，必须同时包含大小写英文字母、数字和特殊符号中的三类字符。特殊符号可以是：()`~!@#$%^&*-_+=', + 'type' => 'string', + 'required' => false, + 'example' => 'Test123456!', + ], + ], + [ + 'name' => 'AutoRenew', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '是否自动续费。取值范围：'."\n" + .'- true：自动续费。'."\n" + .'- false：不自动续费。'."\n" + ."\n" + .'默认值：true。', + 'type' => 'string', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'PricingCycle', + 'in' => 'query', + 'schema' => [ + 'description' => '包年包月的计费周期，取值： Month（默认值）：按月购买。 Year：按年购买。', + 'type' => 'string', + 'required' => false, + 'example' => 'Month', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '实例包年包月的时间，取值：'."\n" + ."\n" + .'- PricingCycle为**Month**，表示按月付费，取值范围为**1**~**9**。'."\n" + .'- PricingCycle为**Year**，表示按年付费，取值范围为**1**~**3**。'."\n" + ."\n" + .'默认值：1。', + 'type' => 'string', + 'required' => false, + 'example' => '6', + ], + ], + [ + 'name' => 'AccountNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '账号数量。'."\n" + ."\n" + .'**取值说明：**'."\n" + .'- GrafanaWorkspaceEdition为**standard**，该参数无效。'."\n" + .'- GrafanaWorkspaceEdition为**personal_edition**，该参数无效，默认值： 1。'."\n" + .'- GrafanaWorkspaceEdition为**experts_edition**， 可选值分别为：10、30、50，默认值： 10。'."\n" + .'- GrafanaWorkspaceEdition为**advanced_edition**， 该参数无效， 默认值：100。', + 'type' => 'string', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'CustomAccountNumber', + 'in' => 'query', + 'schema' => [ + 'description' => '用户额外自定义账号数量。'."\n" + ."\n" + .'**取值说明：**'."\n" + .'- GrafanaWorkspaceEdition为**standard**，该参数无效。'."\n" + .'- GrafanaWorkspaceEdition为**personal_edition**，该参数无效。'."\n" + .'- GrafanaWorkspaceEdition为**experts_edition**， 该参数无效。'."\n" + .'- GrafanaWorkspaceEdition为**advanced_edition**， 取值范围0~2000，且为10的倍数， 默认值：0。', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境（若不填，默认为 zh）：'."\n" + .'- zh '."\n" + .'- en', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + 'default' => 'zh', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例的资源组ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema 返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'D80ADAAC-8C32-5479-BD14-C28CF832****', + ], + 'Data' => [ + 'description' => 'Grafana 工作区信息。', + '$ref' => '#/components/schemas/GrafanaWorkspace', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '是否创建成功。'."\n" + ."\n" + .'- `true`：修改成功'."\n" + .'- `false`：修改失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceId' => [ + 'description' => '调用链ID，用于精确查询调用信息。', + 'type' => 'string', + 'example' => 'eac0a8048716731735000007137d000b', + ], + ], + ], + ], + ], + '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\\": \\"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' => '创建Grafana工作区', + 'description' => '请确保在使用该接口前，已充分了解可观测可视化 Grafana 版产品的收费方式和<props="china">[价格](https://help.aliyun.com/zh/grafana/product-overview/billing-4?spm=openapi-amp.newDocPublishment.0.0.7453281fkrsWrp)</props><props="intl">[价格](https://www.alibabacloud.com/help/zh/grafana/product-overview/billing-4?spm=a2c4g.11186623.0.0.14c2d253B3SDbt)</props>。'."\n" + .'> '."\n" + .'> - 创建可观测可视化 Grafana 版实例需要通过实名认证。<props="china">您可以参见[账号实名认证](https://help.aliyun.com/zh/account/user-guide/individual-identities)相关文档完成认证。</props>'."\n" + .'> - 普通用户只支持创建开发者版、专家版、高级版 （`会产生费用`）。'."\n" + .'> - 内部测试用户只支持创建内测版（`免费`）。', + ], + 'UpdateGrafanaWorkspace' => [ + 'summary' => '更新指定Grafana工作区信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GrafanaWorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作区 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grafana-cn-4xl3g******', + ], + ], + [ + 'name' => 'GrafanaWorkspaceName', + 'in' => 'query', + 'schema' => [ + 'description' => '工作区名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'testGrafana', + ], + ], + [ + 'name' => 'Description', + 'in' => 'query', + 'schema' => [ + 'description' => '工作区描述。', + 'type' => 'string', + 'required' => false, + 'example' => '线上生产环境Grafana', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境，默认为中文：zh， 英文： en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + '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' => '16AF921B-8187-489F-9913-43C808B4****', + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息', + 'type' => 'string', + 'example' => 'message', + ], + 'Code' => [ + 'description' => '接口状态码：'."\n" + ."\n" + .'- `2XX`：成功'."\n" + .'- `3XX`：重定向'."\n" + .'- `4XX`：请求错误'."\n" + .'- `5XX`：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- `true`：调用成功'."\n" + .'- `false`：调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceId' => [ + 'description' => '调用链ID，用于精确查询调用信息。', + 'type' => 'string', + 'example' => 'eac0a8048716731735000007137d000b', + ], + 'Data' => [ + 'description' => '更新是否成功。'."\n" + ."\n" + .'- `true`更新成功'."\n" + .'- `false`更新失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"16AF921B-8187-489F-9913-43C808B4****\\",\\n \\"Message\\": \\"message\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '更新Grafana工作区', + ], + 'UpdateGrafanaWorkspaceVersion' => [ + 'summary' => '更新Grafana工作区版本。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GrafanaWorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '工作区 ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grafana-cn-4xl3g******', + ], + ], + [ + 'name' => 'GrafanaVersion', + 'in' => 'query', + 'schema' => [ + 'description' => 'Grafana版本。', + 'type' => 'string', + 'required' => true, + 'example' => '10.0.x', + ], + ], + [ + 'name' => 'AliyunLang', + 'in' => 'query', + 'schema' => [ + 'description' => '语言环境，默认为中文：zh， 英文： en。', + 'type' => 'string', + 'required' => false, + 'example' => 'zh', + ], + ], + ], + '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' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Message' => [ + 'description' => '请求参数错误时返回的信息', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '接口状态码：'."\n" + ."\n" + .'- `2XX`：成功'."\n" + .'- `3XX`：重定向'."\n" + .'- `4XX`：请求错误'."\n" + .'- `5XX`：服务器错误', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。'."\n" + ."\n" + .'- `true`调用成功'."\n" + .'- `false`调用失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceId' => [ + 'description' => '调用链ID，用于精确查询调用信息。', + 'type' => 'string', + 'example' => 'eac0a8048716731735000007137d000b', + ], + 'Data' => [ + 'description' => '更新是否成功。'."\n" + ."\n" + .'- `true`更新成功'."\n" + .'- `false`更新失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"2A0CEDF1-06FE-44AC-8E21-21A5BE65****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '更新Grafana工作区版本', + 'description' => '说明：本接口返回列表包含开发者版、专家版、高级版 ，不包含共享版。', + ], + 'DeleteGrafanaWorkspace' => [ + 'summary' => '删除可观测可视化 Grafana 版工作区实例。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + 'autoTest' => false, + 'notSupportAutoTestReason' => '涉及数据库任务，为了客户恢复需求，数据库资源不做释放，自动化调用资源浪费', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'GrafanaWorkspaceId', + 'in' => 'query', + 'schema' => [ + 'description' => '可观测可视化 Grafana 版工作区ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'grafana-rnglkcdrntlhk0****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema 返回值。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Success' => [ + 'description' => '请求是否执行成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceId' => [ + 'description' => '调用链ID，用于精确查询调用信息。', + 'type' => 'string', + 'example' => 'eac0a8048716731735000007137d000b', + ], + 'Data' => [ + 'description' => 'Grafana是否删除成功：'."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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\\": \\"27E653FA-5958-45BE-8AA9-14D884DC****\\",\\n \\"Message\\": \\"success\\",\\n \\"Code\\": 200,\\n \\"Success\\": true,\\n \\"TraceId\\": \\"eac0a8048716731735000007137d000b\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除Grafana工作区', + 'description' => '<props="china">>'."\n" + .'> - 该接口仅支持内测版（`免费`）Grafana实例进行删除操作。'."\n" + .'> - 开发者版、专家版、高级版不支持删除操作，请到[费用与成本](https://usercenter2.aliyun.com/refund/refund)进行资源退订。</props>'."\n" + ."\n" + .'<props="intl"></props>'."\n" + .'> 该接口仅支持内测版（`免费`）Grafana实例进行删除操作。', + ], + 'ApplyScenario' => [ + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjiakou', + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'description' => '使用场景。选项：'."\n" + ."\n" + .'- `USER-DEFINED`（默认）：用户自定义。'."\n" + .'- `EDAS-ROLLOUT`：EDAS应用发布。'."\n" + .'- `OAM-ROLLOUT`：OAM应用发布。'."\n" + .'- `MSC-CANARY`：MSE金丝雀发布。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER-DEFINED', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '业务监控名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '测试POP业务监控', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b590lhguqs@28f515462f******', + ], + ], + [ + 'name' => 'Sign', + 'in' => 'query', + 'schema' => [ + 'description' => '场景编码。新建业务监控时无需设置，更新业务监控时必须设置。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'a9f8****', + ], + ], + [ + 'name' => 'Config', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '业务监控配置JSON字段。关于此字段的详细说明参见下文关于参数**Config**的补充说明。', + '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' => '染色标是否向下透传。'."\n" + ."\n" + .'- `true`'."\n" + .'- `false`（默认）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SnStat', + 'in' => 'query', + 'schema' => [ + 'description' => '染色标是否统计流量。'."\n" + .'- `true`'."\n" + .'- `false`（默认）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SnDump', + 'in' => 'query', + 'schema' => [ + 'description' => '染色标的链路是否Dump业务参数。'."\n" + .'- `true`'."\n" + .'- `false`（默认）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'SnForce', + 'in' => 'query', + 'schema' => [ + 'description' => '染色标的链路是否全量采集。'."\n" + .'- `true`'."\n" + .'- `false`（默认）', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'UpdateOption', + 'in' => 'query', + 'schema' => [ + 'description' => '是否更新操作。'."\n" + ."\n" + .'- `true`：更新操作。'."\n" + .'- `false`：插入操作。', + 'type' => 'boolean', + 'required' => true, + 'docRequired' => true, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '场景编码，即染色标。', + 'type' => 'string', + 'example' => '2b97****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EA24D522-AD35-47B8-8CB2-ADBC38******', + ], + ], + ], + ], + ], + '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' => '创建或更新业务监控', + 'summary' => '创建或更新业务监控。', + 'requestParamsDescription' => '## 关于参数**Config**的补充说明'."\n" + .'**JSON串示例及说明**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "rpcType":"0", //服务类型。0：HTTP入口；255：Kubernete Pod Metadata。'."\n" + .' "nameMatchType":"EQUALS", //服务名称匹配规则。EQUALS：等于；STARTSWITH：开始等于；CONTAINS：包含；ENDSWITH：结束等于；PATTERNS：模式匹配。'."\n" + .' "service":"/api/pop/test", //服务名称。'."\n" + .' "operator":"and", //过滤规则关系。 and：同时满足规则；or：满足任一规则。'."\n" + .' "filterItems": //过滤规则。'."\n" + .' [{'."\n" + .' "type":"HttpHeaders", //过滤规则匹配参数，详见下一节。'."\n" + .' "key":"uid", //过滤字段匹配Key值。'."\n" + .' "opt":"==", //匹配方式。支持==、!=和contains。'."\n" + .' "value":"123456789" //过滤字段阈值。'."\n" + .' }],'."\n" + .' "group": //分组规则。'."\n" + .' {'."\n" + .' "type":"HttpRequestParameters", //分组规则匹配参数，详见下一节。'."\n" + .' "key":"name" //分组规则匹配Key值。'."\n" + .' }'."\n" + .'}'."\n" + .'```'."\n" + .'**过滤规则匹配参数**'."\n" + ."\n" + .'当服务类型设置为rpcType=0（即HTTP入口）时的匹配参数：'."\n" + .'- HttpRequestParameters'."\n" + .'- HttpHeaders'."\n" + .'- HttpCookies'."\n" + .'- HttpMethod'."\n" + .'- HttpPathVariables'."\n" + ."\n" + .'当服务类型设置为rpcType=255（即Kubernete Pod Metadata）时的匹配参数：'."\n" + .'- k8sPodLabel'."\n" + .'- k8sPodAnnotation'."\n" + .'- k8sPodName'."\n" + .'- k8sPodNamespace'."\n" + .'- k8sPodUID'."\n" + .'- k8sPodIp'."\n" + .'- k8sPodServiceAccount'."\n" + ."\n" + .'**分组规则匹配参数**'."\n" + ."\n" + .'当服务类型设置为rpcType=0（即HTTP入口）时的匹配参数：'."\n" + .'- HttpRequestParameters'."\n" + .'- HttpHeaders'."\n" + .'- HttpCookies'."\n" + .'- HttpMethod'."\n" + .'- HttpPathVariables'."\n" + ."\n" + .'当服务类型设置为rpcType=255（即Kubernete Pod Metadata）时的匹配参数：'."\n" + .'- k8sPodLabel'."\n" + .'- k8sPodAnnotation'."\n" + .'- k8sPodName'."\n" + .'- k8sPodNamespace'."\n" + .'- k8sPodUID'."\n" + .'- k8sPodIp'."\n" + .'- k8sPodServiceAccount', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteScenario' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ScenarioId', + 'in' => 'query', + 'schema' => [ + 'description' => '业务监控ID，可通过ListScenario接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '1', + 'example' => '132', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjaikou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Result' => [ + 'description' => '是否删除成功。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'EA24D522-AD35-47B8-8CB2-ADBC382B****', + ], + ], + ], + ], + ], + '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' => '删除业务监控', + 'summary' => '删除业务监控。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListScenario' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-zhangjaikou', + ], + ], + [ + 'name' => 'Scenario', + 'in' => 'query', + 'schema' => [ + 'description' => '使用场景。选项：'."\n" + ."\n" + .'- `USER-DEFINED`（默认）：用户自定义。'."\n" + .'- `EDAS-ROLLOUT`：EDAS应用发布。'."\n" + .'- `OAM-ROLLOUT`：OAM应用发布。'."\n" + .'- `MSC-CANARY`：MSE金丝雀发布。', + 'type' => 'string', + 'required' => false, + 'example' => 'USER-DEFINED', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '业务监控名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '测试业务监控', + ], + ], + [ + 'name' => 'AppId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'b590lhguqs@28f515462******', + ], + ], + [ + 'name' => 'Sign', + 'in' => 'query', + 'schema' => [ + 'description' => '场景编码，明确知道目标业务场景编码时设置。', + 'type' => 'string', + 'required' => false, + 'example' => 'a9f8****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '98027D1F-3AEB-492C-A4AA-E9217992****', + ], + 'ArmsScenarios' => [ + 'description' => '业务监控详细信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '业务监控更新时间。', + 'type' => 'string', + 'example' => '1585214916000', + ], + 'AppId' => [ + 'description' => '应用ID。', + 'type' => 'string', + 'example' => 'b590lhguqs@28f515462******', + ], + 'Sign' => [ + 'description' => '业务监控对应编码。', + 'type' => 'string', + 'example' => 'a9f8****', + ], + 'CreateTime' => [ + 'description' => '业务监控创建时间。', + 'type' => 'string', + 'example' => '1585214916000', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'Extensions' => [ + 'description' => '扩展信息字段JSON串。', + 'type' => 'string', + 'example' => '{"_MODE": "CUSTOM-TRANSACTION","_SCENARIO": "USER-DEFINED"}', + ], + 'Name' => [ + 'description' => '业务监控名称。', + 'type' => 'string', + 'example' => '测试业务监控', + ], + 'Id' => [ + 'description' => '业务监控ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '132', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取业务监控详细信息', + 'summary' => '获取业务监控详细信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateTimingSyntheticTask' => [ + 'summary' => '创建定时拨测任务（新版）。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域ID。', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '拨测任务名称，不允许重复。', + 'description' => '拨测任务名称，不允许重复。', + 'type' => 'string', + 'required' => true, + 'example' => 'demo-test', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'title' => '任务类型：'."\n" + .'1：ICMP'."\n" + .'2：TCP'."\n" + .'3：DNS'."\n" + .'4：HTTP'."\n" + .'5：网站测速'."\n" + .'6：文件下载'."\n", + 'description' => '任务类型：'."\n" + .'- 1：ICMP'."\n" + .'- 2：TCP'."\n" + .'- 3：DNS'."\n" + .'- 4：HTTP'."\n" + .'- 5：网站测速'."\n" + .'- 6：文件下载', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '4', + ], + ], + [ + 'name' => 'MonitorConf', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'title' => '监测配置。', + 'description' => '监测配置。', + 'type' => 'object', + 'properties' => [ + 'NetICMP' => [ + 'title' => 'ICMP拨测配置参数。当TaskType为1时必填。', + 'description' => 'ICMP拨测配置参数。当TaskType为1时必填。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'title' => '拨测目标地址（主机）。', + 'description' => '拨测目标地址，只能输入P地址或者域名。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com', + ], + 'Interval' => [ + 'title' => 'ICMP（Ping）数据包发送的时间间隔。单位为毫秒(ms)，最小值为200，最大值为2000，默认为200。', + 'description' => 'ICMP（Ping）数据包发送的时间间隔。单位为毫秒（ms），最小值为200，最大值为2000，默认为200。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + 'PackageNum' => [ + 'title' => '发送ICMP（Ping）数据包的数量。最小值为1，最大值为16，默认为4。', + 'description' => '发送ICMP（Ping）数据包的数量。最小值为1，最大值为50，默认为4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'PackageSize' => [ + 'title' => '发送ICMP（Ping）数据包的大小。单位为byte，允许设置为32, 64, 128, 256, 512, 1024。', + 'description' => '发送ICMP（Ping）数据包的大小。单位为byte，ICMP（PING）包大小只限32、64、128、256、512、1024、1080、1450。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'enumValueTitles' => [], + 'example' => '32', + ], + 'SplitPackage' => [ + 'title' => '是否拆分ICMP（Ping）数据包。默认为true。', + 'description' => '是否拆分ICMP（Ping）数据包。默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'Timeout' => [ + 'title' => 'ICMP拨测的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'description' => 'ICMP拨测的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000', + ], + 'TracertEnable' => [ + 'title' => '是否开启tracert。默认为true。', + 'description' => '是否开启tracert。默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'TracertNumMax' => [ + 'title' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'description' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'TracertTimeout' => [ + 'title' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'description' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60000', + ], + ], + 'required' => false, + ], + 'NetTCP' => [ + 'title' => 'TCP拨测的配置参数。当TaskType为2时必填。', + 'description' => 'TCP拨测的配置参数。当TaskType为2时必填。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'title' => '拨测目标地址（主机）。', + 'description' => '拨测目标地址（主机）。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.example.com'."\n", + ], + 'ConnectTimes' => [ + 'title' => '建立TCP连接的次数。最小值为1，最大值为16，默认为4。', + 'description' => '建立TCP连接的次数。最小值为1，最大值为16，默认为4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'Interval' => [ + 'title' => '建立TCP连接的时间间隔。单位为毫秒（ms），最小值为200，最大值为2000，默认为200。', + 'description' => '建立TCP连接的时间间隔。单位为毫秒（ms），最小值为200，最大值为10000，默认为200。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '200', + ], + 'Timeout' => [ + 'title' => 'TCP拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'description' => 'TCP拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000', + ], + 'TracertEnable' => [ + 'title' => '是否开启tracert。默认为true。', + 'description' => '是否开启tracert。默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'TracertNumMax' => [ + 'title' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'description' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'TracertTimeout' => [ + 'title' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'description' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60000', + ], + ], + 'required' => false, + ], + 'NetDNS' => [ + 'title' => 'DNS拨测的配置参数。当TaskType为3时必填。', + 'description' => 'DNS拨测的配置参数。当TaskType为3时必填。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'title' => 'DNS拨测的目标地址（域名）。', + 'description' => 'DNS拨测的目标地址（域名）。', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyun.com', + ], + 'DnsServerIpType' => [ + 'title' => 'DNS服务器IP类型。0-自动, 1-IPv4，2-IPv6，默认为0。', + 'description' => 'DNS服务器IP类型。'."\n" + ."\n" + .'- 0（默认）：ipv4'."\n" + .'- 1：ipv6'."\n" + .'- 2：自动', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'NsServer' => [ + 'title' => 'NS服务器IP，默认114.114.114.114。', + 'description' => 'NS服务器IP，默认114.114.114.114。', + 'type' => 'string', + 'required' => false, + 'example' => '114.114.114.114', + ], + 'QueryMethod' => [ + 'title' => 'DNS查询方式，0-递归，1-迭代，默认为0。', + 'description' => 'DNS查询方式。'."\n" + ."\n" + .'- 0（默认）：递归'."\n" + .'- 1：迭代', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Timeout' => [ + 'title' => 'DNS拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为45000，默认为5000。', + 'description' => 'DNS拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为45000，默认为5000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + ], + 'required' => false, + ], + 'ApiHTTP' => [ + 'description' => 'HTTP（S）类型任务配置信息。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测目标地址（请求路径）。', + 'type' => 'string', + 'required' => true, + 'example' => 'http://www.demo.com/api/list', + ], + 'Method' => [ + 'description' => 'HTTP方法，GET或POST。', + 'type' => 'string', + 'required' => false, + 'example' => 'GET', + ], + 'RequestHeaders' => [ + 'description' => 'HTTP请求头。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + 'description' => 'JSON Map格式。', + ], + ], + 'RequestBody' => [ + 'description' => 'HTTP请求体。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '请求体内容，为JSON字符串格式。当type为text/plain，application/json，application/xml，text/html，content内容转为JSON字符串即可。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + ], + 'Type' => [ + 'description' => '请求体类型，支持：text/plain、application/json、application/x-www-form-urlencoded、multipart/form-data、application/xml、text/html', + 'type' => 'string', + 'required' => false, + 'example' => 'application/json', + ], + ], + 'required' => false, + ], + 'ConnectTimeout' => [ + 'description' => '连接超时, 单位ms，默认5000，可选范围：1000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'Timeout' => [ + 'description' => '超时时间，单位ms，默认10000，可选范围：1000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10000', + ], + 'CheckCert' => [ + 'description' => '是否校验证书，默认为否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ProtocolAlpnProtocol' => [ + 'description' => 'ALPN 协议版本（wap移动端并且是HTTPS任务时可配置）：'."\n" + ."\n" + .'0-default 系统默认行为 '."\n" + ."\n" + .'1-http/1.1'."\n" + ."\n" + .'2-h2'."\n" + ."\n" + .'3-off 关闭,不启用 alpn_protocol', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'Website' => [ + 'description' => '网站测速类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '目标URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://www.aliyun.com', + ], + 'AutomaticScrolling' => [ + 'description' => '是否支持自动滚动屏幕，加载页面。'."\n" + ."\n" + .'- 0（默认）：否'."\n" + .'- 1：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'CustomHeader' => [ + 'description' => '自定义header。'."\n" + ."\n" + .'- 0（默认）：关'."\n" + .'- 1：修改第一包'."\n" + .'- 2：修改全部包', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义header，JSON Map格式。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'JSON Map', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}'."\n", + ], + ], + 'DisableCache' => [ + 'description' => '是否禁用缓存。'."\n" + ."\n" + .'- 0：不禁用'."\n" + .'- 1（默认）：禁用', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'DisableCompression' => [ + 'description' => '通过Accept-Encoding字段判断是否接受压缩文件，0-不禁用，1-禁用，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FilterInvalidIP' => [ + 'description' => '是否过滤非有效IP参数非法，0：过滤，1：不过滤，默认0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreCertificateError' => [ + 'description' => '是否忽略在SSL握手中证书校验过程中的证书错误而继续浏览，0-不忽略，1-忽略，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时，单位为ms。非必填，默认20000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000', + ], + 'Redirection' => [ + 'description' => '当出现重定向后，是否要继续浏览, 0-否，1-是，默认是1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'SlowElementThreshold' => [ + 'description' => '慢元素阈值，单位为ms，默认5000，可选范围为1~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'WaitCompletionTime' => [ + 'description' => '最大等待完成时间，单位为ms，默认5000，可选范围为：5000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'VerifyStringBlacklist' => [ + 'description' => '验证字符串即监测页面源代码中的某个任意字符串。若客户端返回的源码中包含任一黑名单中的字符串则报650验证字符串失败的错误。多个字符串以竖线（|）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'error', + ], + 'VerifyStringWhitelist' => [ + 'description' => '验证字符串即监测页面源代码中的某个任意字符串。客户端返回的源码必须包含所有白名单中的字符串，否则报650验证字符串失败的错误。多个字符串以竖线（|）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + 'ElementBlacklist' => [ + 'description' => '在页面加载过程中如果出现元素黑名单中配置的元素，不会请求加载该元素 。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com/a.jpg', + ], + 'DNSHijackWhitelist' => [ + 'description' => '域名（例如www.aliyun.com）解析时，解析出的IP地址或者CNAME不在DNS劫持白名单内，用户就会访问失败或者返回一个非Aliyun的目标IP；若解析结果中的IP或者CNAME在DNS白名单内，则会被认定为没有发生DNS劫持。'."\n" + ."\n" + .'填写格式：域名:匹配规则。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：www.aliyun.com:203.0.3.55|203.3.44.67，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + 'PageTamper' => [ + 'description' => '监测页面出现了域名设置之外的元素都属于页面被篡改。常见的表现形式为弹出广告、浮动广告、跳转等。'."\n" + ."\n" + .'填写格式：域名:元素。元素支持填写通配符，可以填写多个元素，多个元素以竖线（|）隔开。例如：www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg，表示www.aliyun.com域名下除基础文档、/cc/bb/a.gif和/vv/bb/cc.jpg之外的其他元素都属于页面被篡改。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', + ], + 'FlowHijackJumpTimes' => [ + 'description' => '识别元素：设置浏览页面元素总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + 'FlowHijackLogo' => [ + 'description' => '劫持标识：设置匹配的关键信息。填写劫持判断关键字或关键元素，允许带星号（*）。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + ], + 'required' => false, + ], + 'FileDownload' => [ + 'description' => '文件下载类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '文件下载链接。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png', + ], + 'DownloadKernel' => [ + 'description' => '下载内核。'."\n" + ."\n" + .'- 1：curl'."\n" + .'- 0：WinInet'."\n" + ."\n" + .'默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'QuickProtocol' => [ + 'description' => 'Quick协议'."\n" + ."\n" + .'- 1：http1'."\n" + .'- 2：http2'."\n" + .'- 3：http3'."\n" + ."\n" + .'默认1', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ConnectionTimeout' => [ + 'description' => '连接超时时间，ms，默认5000，可选范围：1000~120000ms之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时时间，ms，默认60000，可选范围：1000~120000ms之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60000', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义请求头内容，JSON Map。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + 'description' => 'JSON Map。', + ], + ], + 'IgnoreCertificateStatusError' => [ + 'description' => '证书状态错误忽略，0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'IgnoreCertificateUntrustworthyError' => [ + 'description' => '证书不可信忽略，0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'IgnoreInvalidHostError' => [ + 'description' => '主机无效错误忽略，0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Redirection' => [ + 'description' => '是否支持重定向, 0：不支持，1：支持，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'TransmissionSize' => [ + 'description' => '传输大小，KB，默认2048KB，文件下载的传输大小必须在1~20480KB之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2048', + ], + 'IgnoreCertificateCanceledError' => [ + 'description' => '忽略证书撤销错误 0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'IgnoreCertificateAuthError' => [ + 'description' => '忽略CA证书授权错误 0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'IgnoreCertificateOutOfDateError' => [ + 'description' => '忽略证书过期错误 0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'IgnoreCertificateUsingError' => [ + 'description' => '忽略证书使用错误 0：不忽略，1：忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'VerifyWay' => [ + 'description' => '验证方式。'."\n" + ."\n" + .'- 0：不验证 '."\n" + .'- 1：验证字符串 '."\n" + .'- 2：MD5验证', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ValidateKeywords' => [ + 'description' => '验证关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + 'WhiteList' => [ + 'description' => 'DNS劫持白名单。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：www.aliyun.com:203.0.3.55|203.3.44.67，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + ], + 'required' => false, + ], + 'Stream' => [ + 'description' => '流媒体拨测配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '流媒体资源地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/stream/test.mp4'."\n", + ], + 'StreamType' => [ + 'description' => '音视频标志：0-视频，1-音频。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'StreamMonitorTimeout' => [ + 'description' => '监测时长，单位秒，最长支持60s，不传默认60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'StreamAddressType' => [ + 'description' => '资源地址类型：'."\n" + ."\n" + .'- 1：资源地址。'."\n" + .'- 0：页面地址，不传默认0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'PlayerType' => [ + 'description' => '播放器，不传默认12。'."\n" + ."\n" + .'- 12：VLC '."\n" + .'- 2：FlashPlayer', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '12', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义header，JSON Map格式。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}'."\n", + 'description' => '自定义header，JSON Map格式。', + ], + ], + 'WhiteList' => [ + 'description' => 'DNS劫持白名单。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：www.aliyun.com:203.0.3.55|203.3.44.67，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + ], + 'required' => false, + ], + ], + 'required' => true, + ], + ], + [ + 'name' => 'MonitorCategory', + 'in' => 'query', + 'schema' => [ + 'description' => '监测点类型：'."\n" + ."\n" + .'- 1：PC端'."\n" + .'- 2：移动端', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Monitors', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监测点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监测点列表。', + 'type' => 'object', + 'properties' => [ + 'CityCode' => [ + 'description' => '城市编码。', + 'type' => 'string', + 'required' => true, + 'example' => '100023', + ], + 'OperatorCode' => [ + 'description' => '运营商编码。', + 'type' => 'string', + 'required' => true, + 'example' => '1', + ], + 'ClientType' => [ + 'description' => '拨测点客户端类型：'."\n" + ."\n" + .'- 1：IDC'."\n" + .'- 2：网民'."\n" + .'- 3：移动端'."\n" + .'- 4：云主机', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => true, + ], + 'required' => true, + ], + ], + [ + 'name' => 'Frequency', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测频率：1m、5m、10m、15m、20m、30m、1h、2h、3h、4h、6h、8h、12h、24h。', + 'type' => 'string', + 'required' => true, + 'example' => '5m', + ], + ], + [ + 'name' => 'CustomPeriod', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义周期', + 'type' => 'object', + 'properties' => [ + 'EndHour' => [ + 'description' => '结束小时，0-24。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '22', + ], + 'StartHour' => [ + 'description' => '开始小时，0-24。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '8', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CommonSetting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通用设置。', + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => '自定义host', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'host列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义host', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名', + 'type' => 'string', + 'required' => true, + 'example' => 'www.aliyun.com', + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPv6', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + 'Ips' => [ + 'description' => 'IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP。', + 'type' => 'string', + 'required' => true, + 'example' => '10.176.141.63', + ], + 'required' => true, + ], + ], + 'required' => true, + ], + 'required' => true, + ], + 'SelectType' => [ + 'description' => '选择方式：'."\n" + ."\n" + .'- 0：随机'."\n" + .'- 1：轮询', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPv6', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MonitorSamples' => [ + 'description' => '是否均匀分配监测样本 ：'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IsOpenTrace' => [ + 'description' => '是否开启链路追踪。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'TraceClientType' => [ + 'description' => '链路追踪客户端类型：'."\n" + ."\n" + .'- 0：ARMS Agent'."\n" + .'- 1：OpenTelemetry'."\n" + .'- 2：Jaeger', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'XtraceRegion' => [ + 'description' => '链路数据上报region。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'CustomVPCSetting' => [ + 'description' => '用户VPC信息，如果拨测的是阿里云内网地址，需要配置VPC信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'VpcId' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp1muectbr8f90vjxxxxx', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-bp14crq29vpycxp8xxxxx', + ], + 'SecureGroupId' => [ + 'description' => '安全组ID，此安全组是拨测客户端所在的安全组，安全组限定了拨测客户端在VPC中的出入站规则。需要设置您的VPC所在安全组的入站规则为允许拨测客户端所在的安全组访问。否则，拨测客户端无法顺畅地访问您的VPC内资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-bp13wzf9vuwegmpxxxxx', + ], + ], + 'required' => false, + ], + 'CustomPrometheusSetting' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '保留字段。', + 'example' => '保留字段。', + ], + ], + 'PrometheusClusterId' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段。', + ], + 'PrometheusClusterRegion' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段。', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AvailableAssertions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '断言列表', + 'type' => 'array', + 'items' => [ + 'description' => '断言', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '断言类型，包括：HttpResCode、HttpResHead、HttpResBody、HttpResBodyJson、HttpResponseTime、IcmpPackLoss（丢包率）、IcmpPackMaxLatency（最大包延时ms）、IcmpPackAvgLatency（平均延时）、TraceRouteHops（跃点数目）、DnsARecord（A记录）、DnsCName（Cname）、websiteTTFB（首包时间）、websiteTTLB（尾包时间）、websiteFST（首屏时间）、websiteFFST（首屏完全渲染时间）、websiteOnload（完全加载时间），具体使用见下文补充说明。', + 'type' => 'string', + 'required' => true, + 'example' => 'DnsARecord', + ], + 'Target' => [ + 'description' => '检查目标，当为HttpResCode与HttpResBody、HttpResponseTime时，target不需要填，当为HttpResHead时，需指定header中的key，当为HttpResBodyJson时，使用jsonPath。', + 'type' => 'string', + 'required' => false, + 'example' => 'key', + ], + 'Operator' => [ + 'description' => '条件：gt：大于；gte：大于等于；lt：小于；te：小于或等于；eq：等于；neq：不等于；ctn：包含；nctn：不包含；exist：存在；n_exist：不存在；belong：属于；n_belong：不属于；reg_match：正则匹配。', + 'type' => 'string', + 'required' => true, + 'example' => 'eq', + ], + 'Expect' => [ + 'description' => '期望值', + 'type' => 'string', + 'required' => true, + 'example' => '200', + ], + ], + 'required' => true, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '可不传', + 'type' => 'string', + 'required' => false, + 'example' => 'xxxx', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Key', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => '500', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '53B5874D-EBC1-5567-B787-E4B7267F5CEB', + ], + 'Success' => [ + 'description' => '操作是否成功：true：操作成功 false：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', + ], + 'Status' => [ + 'description' => '任务状态。取值：'."\n" + ."\n" + .'- **INIT**：新建任务。'."\n" + .'- **RELEASE**：解析中。'."\n" + .'- **RUNNING**：运行中。'."\n" + .'- **STOP**：暂停。'."\n" + .'- **SYSTEM_STOP**：系统暂停。'."\n" + .'- **CANCEL**：取消。'."\n" + .'- **SYSTEM_CANCEL**：系统取消。'."\n" + .'- **DONE**：已经完成。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建定时拨测任务', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'requestParamsDescription' => '断言配置说明如下：'."\n" + ."\n" + .'**HTTP类型任务**'."\n" + ."\n" + .'- type为HttpResCode时，operator支持eq、neq、gt、gte、lt、lte、belong、n_belong'."\n" + ."\n" + .'- type为HttpResHead时，operator支持所有'."\n" + ."\n" + .'- type为HttpResBody，operator支持所有'."\n" + ."\n" + .'- type为HttpResBodyJson，operator支持所有'."\n" + ."\n" + .'- type为HttpResponseTime，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'**ICMP类型任务**'."\n" + ."\n" + .'- type为IcmpPackLoss时，名称为丢包率%，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- type为IcmpPackMaxLatency时，名称为最大包延时ms，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- type为IcmpPackAvgLatency时，名称为平均延时ms，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- TraceRouteHops时，名称为跃点数目，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'**DNS类型任务**'."\n" + ."\n" + .'- type为DnsARecord时，名称为A记录，target有两个选择every(展示-每条记录)和any(展示-存在记录)，支持eq、ctn、nctn、reg_match、not_reg_match'."\n" + ."\n" + .'- type为DnsCName时，名称为Cname，target有两个选择every(展示-每条记录)和any(展示-存在记录)，支持eq、ctn、nctn、reg_match、not_reg_match'."\n" + ."\n" + .'**WEBSITE类型任务**'."\n" + ."\n" + .'- type为websiteTTFB时，名称为首包时间，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- type为websiteTTLB时，名称为尾包时间，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- type为websiteFST时，名称为首屏时间，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- type为websiteFFST时，名称为首屏完全渲染时间，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'- type为websiteOnload时，名称为完全加载时间，支持gt、gte、lt、lte、eq、belong', + ], + 'UpdateTimingSyntheticTask' => [ + 'summary' => '更新定时拨测任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5308a2691f59422c8c3b7aeccxxxxxxx', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '拨测任务', + ], + ], + [ + 'name' => 'MonitorConf', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务配置。', + 'type' => 'object', + 'properties' => [ + 'NetICMP' => [ + 'description' => 'ICMP任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测目标地址，只能输入IP地址或者域名，不能包括端口号、协议头、请求路径等。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + 'Interval' => [ + 'description' => '发送间隔，ICMP(PING)包发送的时间间隔必须在200~10000ms之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + ], + 'PackageNum' => [ + 'description' => '发送ICMP（Ping）数据包的数量。最小值为1，最大值为50，默认为4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'PackageSize' => [ + 'description' => '发送ICMP（Ping）数据包的大小。单位为byte，ICMP(PING)包大小只限32, 64, 128, 256, 512, 1024, 1080, 1450。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '32', + ], + 'SplitPackage' => [ + 'description' => '是否拆分ICMP（Ping）数据包。默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true'."\n", + ], + 'Timeout' => [ + 'description' => 'ICMP拨测的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'TracertEnable' => [ + 'description' => '是否开启tracert。默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'TracertNumMax' => [ + 'description' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'TracertTimeout' => [ + 'description' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60000', + ], + ], + 'required' => false, + ], + 'NetTCP' => [ + 'description' => 'TCP拨测的配置参数。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测目标地址（主机）。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1:8888', + ], + 'ConnectTimes' => [ + 'description' => '建立TCP连接的次数。最小值为1，最大值为16，默认为4。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + 'Interval' => [ + 'description' => '建立TCP连接的时间间隔。单位为毫秒（ms），最小值为200，最大值为10000，默认为200。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + ], + 'Timeout' => [ + 'description' => 'TCP拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + 'TracertEnable' => [ + 'description' => '是否开启tracert。默认为true。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'TracertNumMax' => [ + 'description' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + 'TracertTimeout' => [ + 'description' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'NetDNS' => [ + 'description' => 'DNS任务配置参数。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + 'Dig' => [ + 'description' => '是否以dig形式展示数据内容, 0-否，1-是。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'DnsServerIpType' => [ + 'description' => 'DNS服务器IP类型。0：ipv4，1：ipv6，2: 自动，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'NsServer' => [ + 'description' => 'NS服务器IP，默认114.114.114.114。', + 'type' => 'string', + 'required' => false, + 'example' => '114.114.114.114', + ], + 'QueryMethod' => [ + 'description' => 'DNS查询方式，0-递归，1-迭代，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Timeout' => [ + 'description' => 'DNS拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为45000，默认为5000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1000', + ], + ], + 'required' => false, + ], + 'ApiHTTP' => [ + 'description' => 'HTTP(s)类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测目标地址（请求路径）。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://********', + ], + 'Method' => [ + 'description' => '请求方法。'."\n" + ."\n" + .'- POST'."\n" + .'- GET'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POST', + ], + 'RequestHeaders' => [ + 'description' => '指定的自定义请求头部字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + 'description' => 'HTTP请求头。', + ], + ], + 'RequestBody' => [ + 'description' => 'HTTP 请求体', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '请求体内容，为JSON字符串格式。当type为text/plain，application/json，application/xml，text/html，content内容转为JSON字符串即可。', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + ], + 'Type' => [ + 'description' => '请求体类型，支持：text/plain、application/json、application/x-www-form-urlencoded、multipart/form-data、application/xml、text/html', + 'type' => 'string', + 'required' => false, + 'example' => 'application/json', + ], + ], + 'required' => false, + ], + 'ConnectTimeout' => [ + 'description' => '连接超时，单位ms，默认5000，可选范围1000~300000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'Timeout' => [ + 'description' => '超时时间，单位ms，默认10000，可选范围1000~300000。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'CheckCert' => [ + 'description' => '是否校验证书，默认为否。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'ProtocolAlpnProtocol' => [ + 'description' => 'ALPN 协议版本（wap移动端并且是HTTPS任务时可配置）：'."\n" + ."\n" + .'0-default 系统默认行为 '."\n" + ."\n" + .'1-http/1.1'."\n" + ."\n" + .'2-h2'."\n" + ."\n" + .'3-off 关闭,不启用 alpn_protocol', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'Website' => [ + 'description' => '网站测速类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '网址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://********', + ], + 'AutomaticScrolling' => [ + 'description' => '是否支持自动滚动屏幕，加载页面。0-否，1-是，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'CustomHeader' => [ + 'description' => '自定义header。0：关（默认），1：修改第一包，2：修改全部包。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义header，JSON Map格式。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '自定义header，JSON Map格式。', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + ], + ], + 'DisableCache' => [ + 'description' => '是否禁用缓存，0-不禁用，1-禁用，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'DisableCompression' => [ + 'description' => '通过Accept-Encoding字段判断是否接受压缩文件，0-不禁用，1-禁用，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'FilterInvalidIP' => [ + 'description' => '是否过滤非有效IP。'."\n" + ."\n" + .'- 1：不过滤'."\n" + .'- 0：过滤'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreCertificateError' => [ + 'description' => '是否忽略在SSL握手中证书校验过程中的证书错误而继续浏览，0-不忽略，1-忽略，默认为1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时，单位为ms，默认40000，可选范围为5000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20000', + ], + 'Redirection' => [ + 'description' => '当出现重定向后，是否要继续浏览, 0-否，1-是，默认是1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'SlowElementThreshold' => [ + 'description' => '慢元素阈值，单位为ms，默认5000，可选范围为1~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'WaitCompletionTime' => [ + 'description' => '最大等待完成时间，单位为ms，默认5000，可选范围为：5000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'VerifyStringBlacklist' => [ + 'description' => '验证字符串即监测页面源代码中的某个任意字符串。若客户端返回的源码中包含任一黑名单中的字符串则报650验证字符串失败的错误。多个字符串以竖线（|）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'error', + ], + 'VerifyStringWhitelist' => [ + 'description' => '验证字符串即监测页面源代码中的某个任意字符串。客户端返回的源码必须包含所有白名单中的字符串，否则报650验证字符串失败的错误。多个字符串以竖线（|）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'success', + ], + 'ElementBlacklist' => [ + 'description' => '在页面加载过程中如果出现元素黑名单中配置的元素，不会请求加载该元素 。', + 'type' => 'string', + 'required' => false, + 'example' => 'a.jpg', + ], + 'DNSHijackWhitelist' => [ + 'description' => '域名（例如www.aliyun.com）解析时，解析出的IP地址或者CNAME不在DNS劫持白名单内，用户就会访问失败或者返回一个非Aliyun的目标IP；若解析结果中的IP或者CNAME在DNS白名单内，则会被认定为没有发生DNS劫持。'."\n" + ."\n" + .'填写格式：域名:匹配规则。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：www.aliyun.com:203.0.3.55|203.3.44.67，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + 'PageTamper' => [ + 'description' => '监测页面出现了域名设置之外的元素都属于页面被篡改。常见的表现形式为弹出广告、浮动广告、跳转等。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', + ], + 'FlowHijackJumpTimes' => [ + 'description' => '识别元素：设置浏览页面元素总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'FlowHijackLogo' => [ + 'description' => '劫持标识：设置匹配的关键信息。填写劫持判断关键字或关键元素，允许带星号（*）。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + ], + 'required' => false, + ], + 'FileDownload' => [ + 'description' => '文件下载类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '文件下载链接。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://img.alicdn.com/tfs/TB13DzOjXP7gK0jSZFjXXc5aXXa-212-48.png', + ], + 'DownloadKernel' => [ + 'description' => '下载内核。'."\n" + ."\n" + .'- 1：curl'."\n" + .'- 0：WinInet'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'QuickProtocol' => [ + 'description' => 'Quick协议'."\n" + ."\n" + .'- 1：http1'."\n" + .'- 2：http2'."\n" + .'- 3：http3'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'ConnectionTimeout' => [ + 'description' => '连接超时时间，ms，默认5000，可选范围：1000~120000ms之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5000', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时时间，ms，默认60000，可选范围：1000~120000ms之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60000', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义请求头内容，JSON Map。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + 'description' => '自定义请求头内容，JSON Map。', + ], + ], + 'IgnoreCertificateStatusError' => [ + 'description' => '证书状态错误忽略，0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreCertificateUntrustworthyError' => [ + 'description' => '证书不可信忽略，0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreInvalidHostError' => [ + 'description' => '主机无效错误忽略，0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Redirection' => [ + 'description' => '是否支持重定向, 0:不支持，1:支持，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'TransmissionSize' => [ + 'description' => '传输大小，KB，默认2048KB，文件下载的传输大小必须在1~20480KB之间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2048', + ], + 'IgnoreCertificateCanceledError' => [ + 'description' => '忽略证书撤销错误 0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreCertificateAuthError' => [ + 'description' => '忽略CA证书授权错误 0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreCertificateOutOfDateError' => [ + 'description' => '忽略证书过期错误 0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IgnoreCertificateUsingError' => [ + 'description' => '忽略证书使用错误 0:不忽略，1:忽略，默认1。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'VerifyWay' => [ + 'description' => '验证方式。'."\n" + ."\n" + .'- 0：不验证 '."\n" + .'- 1：验证字符串 '."\n" + .'- 2：MD5验证', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'ValidateKeywords' => [ + 'description' => '验证关键词。', + 'type' => 'string', + 'required' => false, + 'example' => 'aliyun', + ], + 'WhiteList' => [ + 'description' => 'DNS劫持白名单。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：www.aliyun.com:203.0.3.55|203.3.44.67，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + ], + 'required' => false, + ], + 'Stream' => [ + 'description' => '流媒体拨测配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '流媒体地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://www.aliyun.com/stream/test.mp4', + ], + 'StreamType' => [ + 'description' => '音视频标志：0-视频，1-音频。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'StreamMonitorTimeout' => [ + 'description' => '监测时长，单位秒，最长支持60s，不传默认60。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '30', + ], + 'StreamAddressType' => [ + 'description' => '资源地址类型：'."\n" + ."\n" + .'- 1：资源地址。'."\n" + .'- 0：页面地址。不传默认0。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PlayerType' => [ + 'description' => '播放器，不传默认12。'."\n" + ."\n" + .'- 12：VLC'."\n" + .'- 2：FlashPlayer', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '2', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义header，JSON Map格式。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + 'description' => '自定义header，JSON Map格式。', + ], + ], + 'WhiteList' => [ + 'description' => 'DNS劫持白名单。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：www.aliyun.com:203.0.3.55|203.3.44.67，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Monitors', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监测点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监测点列表。', + 'type' => 'object', + 'properties' => [ + 'CityCode' => [ + 'description' => '城市编码。', + 'type' => 'string', + 'required' => false, + 'example' => '100001', + ], + 'OperatorCode' => [ + 'description' => '运营商编码。', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'ClientType' => [ + 'description' => '拨测点客户端类型：'."\n" + ."\n" + .'- 1：IDC'."\n" + .'- 2：网民'."\n" + .'- 3：移动端'."\n" + .'- 4：云主机', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '4', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Frequency', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测频率，可选范围：1m,5m,10m,15m,20m,30m,1h,2h,3h,4h,6h,8h,12h,24h。', + 'type' => 'string', + 'required' => false, + 'example' => '5m', + ], + ], + [ + 'name' => 'CustomPeriod', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义周期。', + 'type' => 'object', + 'properties' => [ + 'EndHour' => [ + 'description' => '当天结束拨测时间的小时数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '22', + ], + 'StartHour' => [ + 'description' => '当天开始拨测时间的小时数。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '14', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CommonSetting', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '通用设置。', + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => '自定义host。', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'host列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义host。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com', + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'Ips' => [ + 'description' => 'IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP地址。', + 'type' => 'string', + 'required' => false, + 'example' => '127.0.0.1', + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'SelectType' => [ + 'description' => '选择方式：'."\n" + ."\n" + .'- 0：随机'."\n" + .'- 1：轮询', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'MonitorSamples' => [ + 'description' => '是否均匀分配监测样本 ：'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '0', + ], + 'IsOpenTrace' => [ + 'description' => '是否开启链路追踪。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + 'TraceClientType' => [ + 'description' => '链路追踪客户端类型：'."\n" + ."\n" + .'- 0：ARMS Agent'."\n" + .'- 1：OpenTelemetry'."\n" + .'- 2：Jaeger', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'XtraceRegion' => [ + 'description' => '链路数据上报region。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'CustomVPCSetting' => [ + 'description' => '用户VPC信息，如果拨测的是阿里云内网地址，需要配置VPC信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'VpcId' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'required' => false, + 'example' => 'vpc-bp15bjtubjytclwxxxxxx', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'vsw-2zevek6r3mpny7wxxxxxv', + ], + 'SecureGroupId' => [ + 'description' => '安全组ID，此安全组是拨测客户端所在的安全组，安全组限定了拨测客户端在VPC中的出入站规则。需要设置您的VPC所在安全组的入站规则为允许拨测客户端所在的安全组访问。否则，拨测客户端无法顺畅地访问您的VPC内资源。', + 'type' => 'string', + 'required' => false, + 'example' => 'sg-xxxxxxxx', + ], + ], + 'required' => false, + ], + 'CustomPrometheusSetting' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '保留字段。', + 'example' => '保留字段。', + ], + ], + 'PrometheusClusterId' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段。', + ], + 'PrometheusClusterRegion' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段。', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'AvailableAssertions', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '断言列表', + 'type' => 'array', + 'items' => [ + 'description' => '断言列表', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '断言类型，包括：HttpResCode、HttpResHead、HttpResBody、HttpResBodyJson、HttpResponseTime、IcmpPackLoss（丢包率）、IcmpPackMaxLatency（最大包延时ms）、IcmpPackAvgLatency（平均延时）、TraceRouteHops（跃点数目）、DnsARecord（A记录）、DnsCName（Cname）、websiteTTFB（首包时间）、websiteTTLB（尾包时间）、websiteFST（首屏时间）、websiteFFST（首屏完全渲染时间）、websiteOnload（完全加载时间），具体使用见下文补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'TraceRouteHops', + ], + 'Target' => [ + 'description' => '检查目标，当为HttpResCode与HttpResBody、HttpResponseTime时，target不需要填，当为HttpResHead时，需指定header中的key，当为HttpResBodyJson时，使用jsonPath。', + 'type' => 'string', + 'required' => false, + 'example' => 'HttpResponseTime', + ], + 'Operator' => [ + 'description' => '条件：gt：大于；gte：大于等于；lt：小于；te：小于或等于；eq：等于；neq：不等于；ctn：包含；nctn：不包含；exist：存在；n_exist：不存在；belong：属于；n_belong：不属于；reg_match：正则匹配。', + 'type' => 'string', + 'required' => false, + 'example' => 'eq'."\n", + ], + 'Expect' => [ + 'description' => '期望值。', + 'type' => 'string', + 'required' => false, + 'example' => '200', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'description' => '标签列表。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'required' => false, + 'example' => 'key'."\n", + ], + 'Value' => [ + 'description' => '标签的值(value)。', + 'type' => 'string', + 'required' => false, + 'example' => 'value', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'example' => '1eeb351722c84e05b52c82fd0dc9953e', + ], + ], + ], + ], + ], + ], + ], + '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', + ], + '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' => '更新定时拨测任务', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + 'requestParamsDescription' => '断言配置说明如下：'."\n" + ."\n" + .'**HTTP类型任务**'."\n" + .'- type为HttpResCode时，operator支持eq、neq、gt、gte、lt、lte、belong、n_belong'."\n" + .'- type为HttpResHead时，operator支持所有'."\n" + .'- type为HttpResBody，operator支持所有'."\n" + .'- type为HttpResBodyJson，operator支持所有'."\n" + .'- type为HttpResponseTime，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'**ICMP类型任务**'."\n" + .'- type为IcmpPackLoss时，名称为丢包率%，支持gt、gte、lt、lte、eq、belong'."\n" + .'- type为IcmpPackMaxLatency时，名称为最大包延时ms，支持gt、gte、lt、lte、eq、belong'."\n" + .'- type为IcmpPackAvgLatency时，名称为平均延时ms，支持gt、gte、lt、lte、eq、belong'."\n" + .'- TraceRouteHops时，名称为跃点数目，支持gt、gte、lt、lte、eq、belong'."\n" + ."\n" + .'**DNS类型任务**'."\n" + .'- type为DnsARecord时，名称为A记录，target有两个选择every（展示-每条记录）和any（展示-存在记录），支持eq、ctn、nctn、reg_match、not_reg_match'."\n" + .'- type为DnsCName时，名称为Cname，target有两个选择every（展示-每条记录）和any（展示-存在记录），支持eq、ctn、nctn、reg_match、not_reg_match'."\n" + ."\n" + .'**WEBSITE类型任务**'."\n" + .'- type为websiteTTFB时，名称为首包时间，支持gt、gte、lt、lte、eq、belong'."\n" + .'- type为websiteTTLB时，名称为尾包时间，支持gt、gte、lt、lte、eq、belong'."\n" + .'- type为websiteFST时，名称为首屏时间，支持gt、gte、lt、lte、eq、belong'."\n" + .'- type为websiteFFST时，名称为首屏完全渲染时间，支持gt、gte、lt、lte、eq、belong'."\n" + .'- type为websiteOnload时，名称为完全加载时间，支持gt、gte、lt、lte、eq、belong', + ], + 'StopTimingSyntheticTask' => [ + 'summary' => '停止定时拨测任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '3cee3d23ev4342342csc', + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结果，成功为true，失败为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '停止定时拨测任务', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + ], + 'StartTimingSyntheticTask' => [ + 'summary' => '启动定时拨测任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12312jejcc23dcewd', + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2A0CEDF1-06FE-44AC-8E21-21A5BE65****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '启动结果，成功为true，失败为false。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => [ + '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' => '启动定时拨测任务', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + ], + 'DeleteTimingSyntheticTask' => [ + 'summary' => '删除定时拨测任务。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2eq4peca****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '是否成功删除：true：删除成功。 false：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"A5EC8221-08F2-4C95-9AF1-49FD998C****\\",\\n \\"Code\\": 200,\\n \\"Message\\": \\"success\\",\\n \\"Data\\": true\\n}","type":"json"}]', + 'title' => '删除定时拨测任务', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + ], + 'GetSyntheticMonitors' => [ + 'summary' => '获取拨测点。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '查询条件。', + 'type' => 'object', + 'properties' => [ + 'TaskType' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'- 1：ICMP '."\n" + .'- 2：TCP '."\n" + .'- 3：DNS '."\n" + .'- 4：HTTP '."\n" + .'- 5：网站测速 '."\n" + .'- 6：文件下载', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'MonitorCategory' => [ + 'description' => '监测点类型。'."\n" + ."\n" + .'- 1：PC端'."\n" + .'- 2：移动端', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + 'Network' => [ + 'description' => '网络类型。'."\n" + ."\n" + .'- 1：内网'."\n" + .'- 2：公网', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + 'required' => true, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FD473FF-5398-5A85-9BF6-7AB45561522F', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '监测点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Country' => [ + 'description' => '国家。', + 'type' => 'string', + 'example' => '中国', + ], + 'Region' => [ + 'description' => '地域。', + 'type' => 'string', + 'example' => '浙江', + ], + 'City' => [ + 'description' => '城市。', + 'type' => 'string', + 'example' => '北京市', + ], + 'CityCode' => [ + 'description' => '城市编码', + 'type' => 'string', + 'example' => '1100101', + ], + 'Operator' => [ + 'description' => '运营商。', + 'type' => 'string', + 'example' => '阿里云', + ], + 'OperatorCode' => [ + 'description' => '运营商编码。', + 'type' => 'string', + 'example' => '1', + ], + 'ClientType' => [ + 'description' => '拨测点客户端类型。'."\n" + ."\n" + .'- 1：IDC'."\n" + .'- 2：网民'."\n" + .'- 3：移动端'."\n" + .'- 4：云主机', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'CanBeSelected' => [ + 'description' => '是否选中。'."\n" + ."\n" + .'- true：选中'."\n" + .'- false：未选中', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Available' => [ + 'description' => '是否可用。'."\n" + ."\n" + .'- true：可用'."\n" + .'- false：不可用', + 'type' => 'string', + 'example' => 'true', + ], + 'Ipv6' => [ + 'description' => '是否支持IPv6。'."\n" + ."\n" + .'- 0：不支持'."\n" + ."\n" + .'- 1：支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取拨测点', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + ], + 'ListTimingSyntheticTasks' => [ + 'summary' => '获取定时拨测任务列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Search', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '搜索关键字', + 'type' => 'object', + 'properties' => [ + 'TaskTypes' => [ + 'description' => '查询的任务类型列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务类型：1：ICMP 2：TCP 3：DNS 4：HTTP 5：网站测速 6：文件下载。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'required' => false, + ], + 'TaskIds' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '181248', + ], + 'required' => false, + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => '拨测', + ], + 'Status' => [ + 'description' => 'CREATING：任务创建中， RUNNING：任务运行中， PARTIAL_RUNNING：任务部分运行中， STOP：任务停止， LIMIT_STOP：任务由于限额停止， EXCEPTION：任务异常， DELETE：任务删除， DELETE_EXCEPTION： 删除异常。', + 'type' => 'string', + 'required' => false, + 'example' => 'CREATING', + ], + 'OrderField' => [ + 'description' => '排序字段，支持按照gmtCreate、gmtModified、status和monitorCount其中之一排序。', + 'type' => 'string', + 'required' => false, + 'example' => 'status', + ], + 'Order' => [ + 'description' => '1:升序 -1:降序', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'Page' => [ + 'description' => '页码，必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量，必填。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '10', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'required' => false, + 'example' => 'mark', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1111', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '730E90FE-996A-5638-99F3-4F0F9038CC6C', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => '任务信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', + ], + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Name' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => '拨测任务', + ], + 'TaskType' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'1：ICMP 2：TCP 3：DNS 4：HTTP 5：网站测速 6：文件下载。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Url' => [ + 'description' => '拨测地址。', + 'type' => 'string', + 'example' => 'https://www.example.com', + ], + 'MonitorCategory' => [ + 'description' => '监测点类型，PC端1，移动端2。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Frequency' => [ + 'description' => '拨测频率，可选范围：1m,5m,10m,15m,20m,30m,1h,2h,3h,4h,6h,8h,12h,24h。', + 'type' => 'string', + 'example' => '1m', + ], + 'MonitorNum' => [ + 'description' => '拨测点个数。', + 'type' => 'string', + 'example' => '10', + ], + 'Status' => [ + 'description' => 'CREATING：任务创建中， RUNNING：任务运行中， PARTIAL_RUNNING：任务部分运行中， STOP：任务停止， LIMIT_STOP：任务由于限额停止， EXCEPTION：任务异常， DELETE：任务删除， DELETE_EXCEPTION： 删除异常。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'GmtCreate' => [ + 'description' => '创建时间。', + 'type' => 'string', + 'example' => '1671454758000', + ], + 'GmtModified' => [ + 'description' => '修改时间。', + 'type' => 'string', + 'example' => '1673085633000', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-aekzgwtq5vxxxxx', + ], + 'CommonSetting' => [ + 'description' => '通用设置。', + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => '自定义host', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => '自定义host。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义host。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.aliyun.com', + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Ips' => [ + 'description' => 'IP地址。', + 'type' => 'array', + 'items' => [ + 'description' => 'IP。', + 'type' => 'string', + 'example' => '39.104.85.210', + ], + ], + ], + ], + ], + 'SelectType' => [ + 'description' => '选择方式：'."\n" + ."\n" + .'- 0：随机'."\n" + .'- 1：轮询', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MonitorSamples' => [ + 'description' => '是否均匀分配监测样本 ：'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsOpenTrace' => [ + 'description' => '是否开启链路追踪。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'TraceClientType' => [ + 'description' => '链路追踪客户端类型：'."\n" + ."\n" + .'- 0：ARMS Agent'."\n" + .'- 1：OpenTelemetry'."\n" + .'- 2：Jaeger', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'XtraceRegion' => [ + 'description' => '链路数据上报region。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'CustomVPCSetting' => [ + 'description' => '用户VPC信息，如果拨测的是阿里云内网地址，需要配置VPC信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-zhangjiakou', + ], + 'VpcId' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'example' => 'vpc-2zehbd4dfzahxxxxxxx', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1bcmj81kxxxxxxx', + ], + 'SecureGroupId' => [ + 'description' => '安全组ID，此安全组是拨测客户端所在的安全组，安全组限定了拨测客户端在VPC中的出入站规则。需要设置您的VPC所在安全组的入站规则为允许拨测客户端所在的安全组访问。否则，拨测客户端无法顺畅地访问您的VPC内资源。', + 'type' => 'string', + 'example' => 'sg-xxxxxxxxxxxxxx', + ], + ], + ], + 'CustomPrometheusSetting' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '保留字段。', + 'example' => '保留字段。'."\n", + ], + ], + 'PrometheusClusterId' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'example' => '保留字段。'."\n", + ], + 'PrometheusClusterRegion' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'example' => '保留字段。', + ], + ], + ], + ], + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + 'Total' => [ + 'description' => '返回结果的总任务数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Page' => [ + 'description' => '当前页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '每页数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + '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' => [ + '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' => '获取定时拨测任务列表', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + ], + 'GetTimingSyntheticTask' => [ + 'summary' => '获取任务详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'required' => false, + 'example' => '856566a9cb2a4cafa05aa95ed0*******', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求id', + 'type' => 'string', + 'example' => 'E13430A6-57A9-56E9-9D8D-28FE8DEBCA40', + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'example' => '5308a2691f59422c8c3b7aeccec9cd3b', + ], + 'RegionId' => [ + 'description' => '区域ID', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'Name' => [ + 'description' => '拨测任务名称', + 'type' => 'string', + 'example' => '拨测任务', + ], + 'TaskType' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'- 1：ICMP'."\n" + .'- 2：TCP'."\n" + .'- 3：DNS'."\n" + .'- 4：HTTP'."\n" + .'- 5：网站测速'."\n" + .'- 6：文件下载', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'MonitorConf' => [ + 'description' => '任务配置', + 'type' => 'object', + 'properties' => [ + 'NetICMP' => [ + 'description' => 'ICMP拨测配置参数。当TaskType为1时必填。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测目标地址（主机）。只能是域名或者IP地址。', + 'type' => 'string', + 'enumValueTitles' => [], + 'example' => 'www.aliyun.com', + ], + 'Interval' => [ + 'description' => '建立TCP连接的时间间隔。单位为毫秒（ms），最小值为200，最大值为10000，默认为200。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'PackageNum' => [ + 'description' => '发送ICMP（Ping）数据包的数量。最小值为1，最大值为50，默认为4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'PackageSize' => [ + 'description' => '发送ICMP（Ping）数据包的大小。单位为byte，允许设置为32, 64, 128, 256, 512, 1024。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1024', + ], + 'SplitPackage' => [ + 'description' => '是否拆分ICMP（Ping）数据包。默认为true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Timeout' => [ + 'description' => '超时时间，单位ms，默认20000，范围1000~300000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2000', + ], + 'TracertEnable' => [ + 'description' => '是否开启tracert。默认为true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TracertNumMax' => [ + 'description' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为64。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '64', + ], + 'TracertTimeout' => [ + 'description' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60000', + ], + ], + ], + 'NetTCP' => [ + 'description' => 'TCP拨测的配置参数。当TaskType为2时必填。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测目标地址。', + 'type' => 'string', + 'example' => '127.0.0.1:8888', + ], + 'ConnectTimes' => [ + 'description' => '单次拨测建立连接的次数，1~16之间，默认4。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Interval' => [ + 'description' => '建立TCP连接的时间间隔。单位为毫秒（ms），最小值为200，最大值为10000，默认为200。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Timeout' => [ + 'description' => 'TCP拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为20000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20000', + ], + 'TracertEnable' => [ + 'description' => '是否开启tracert。默认为true。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TracertNumMax' => [ + 'description' => 'tracert的最大跃点数。最小值为1，最大值为128，默认为20。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TracertTimeout' => [ + 'description' => 'tracert的超时时间。单位为毫秒（ms），最小值为1000，最大值为300000，默认为60000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '60000', + ], + ], + ], + 'NetDNS' => [ + 'description' => 'DNS拨测的配置参数。当TaskType为3时必填。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测域名。', + 'type' => 'string', + 'example' => 'www.aliyun.com', + ], + 'DnsServerIpType' => [ + 'description' => 'DNS服务器IP类型。'."\n" + ."\n" + .'- 0（默认）：ipv4'."\n" + .'- 1：ipv6'."\n" + .'- 2: 自动', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'NsServer' => [ + 'description' => 'NS服务器IP，默认114.114.114.114。', + 'type' => 'string', + 'example' => '114.114.114.114', + ], + 'QueryMethod' => [ + 'description' => 'DNS查询方式，0: 递归， 1：迭代。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Timeout' => [ + 'description' => 'DNS拨测超时时间。单位为毫秒（ms），最小值为1000，最大值为45000，默认为5000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + ], + ], + 'ApiHTTP' => [ + 'description' => 'HTTP(S)类型任务配置信息。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '拨测地址。', + 'type' => 'string', + 'example' => 'http://127.0.0.1:8090/api/list', + ], + 'Method' => [ + 'description' => '请求方法。'."\n" + ."\n" + .'- POST'."\n" + .'- GET'."\n", + 'type' => 'string', + 'example' => 'POST', + ], + 'RequestHeaders' => [ + 'description' => 'HTTP请求头。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => 'JSON Map类型字符串。', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + ], + ], + 'RequestBody' => [ + 'description' => 'HTTP 请求体。', + 'type' => 'object', + 'properties' => [ + 'Content' => [ + 'description' => '请求体内容，为JSON字符串格式。当type为text/plain，application/json，application/xml，text/html，content内容转为JSON字符串即可。', + 'type' => 'string', + 'example' => 'text/plain', + ], + 'Type' => [ + 'description' => '请求体类型，支持：text/plain、application/json、application/x-www-form-urlencoded、multipart/form-data、application/xml、text/html。', + 'type' => 'string', + 'example' => 'multipart/form-data', + ], + ], + ], + 'ConnectTimeout' => [ + 'description' => '连接超时, ms，默认5000，范围为1000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'Timeout' => [ + 'description' => '超时时间，ms，默认10000，范围为1000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10000', + ], + 'CheckCert' => [ + 'description' => '是否校验证书，默认为否。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ProtocolAlpnProtocol' => [ + 'description' => 'ALPN 协议版本（wap移动端并且是HTTPS任务时可配置）：'."\n" + ."\n" + .'0-default 系统默认行为 '."\n" + ."\n" + .'1-http/1.1'."\n" + ."\n" + .'2-h2'."\n" + ."\n" + .'3-off 关闭,不启用 alpn_protocol', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + 'FileDownload' => [ + 'description' => '文件下载类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '下载链接。', + 'type' => 'string', + 'example' => 'https://********', + ], + 'DownloadKernel' => [ + 'description' => '下载内核。'."\n" + ."\n" + .'- 1：curl'."\n" + .'- 0：WinInet'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QuickProtocol' => [ + 'description' => 'Quick协议'."\n" + ."\n" + .'- 1：http1'."\n" + .'- 2：http2'."\n" + .'- 3：http3'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ConnectionTimeout' => [ + 'description' => '连接超时。文件下载的连接超时必须在1000~120000ms之间，默认5000。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义请求头内容，JSON Map。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + 'description' => 'JSON Map。', + ], + ], + 'IgnoreCertificateStatusError' => [ + 'description' => '证书状态错误忽略。'."\n" + ."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IgnoreCertificateUntrustworthyError' => [ + 'description' => '证书不可信忽略。'."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IgnoreInvalidHostError' => [ + 'description' => '主机无效错误忽略。'."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时时间，ms，默认60000，范围1000~120000ms之间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '6000', + ], + 'Redirection' => [ + 'description' => '是否支持重定向。'."\n" + ."\n" + .'- 0：不支持'."\n" + .'- 1（默认）：支持', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'TransmissionSize' => [ + 'description' => '传输大小，KB，默认2048KB，文件下载的传输大小必须在1~20480KB之间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2048', + ], + 'IgnoreCertificateCanceledError' => [ + 'description' => '忽略证书撤销错误。'."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IgnoreCertificateAuthError' => [ + 'description' => '忽略CA证书授权错误。'."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IgnoreCertificateOutOfDateError' => [ + 'description' => '忽略证书过期错误。'."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IgnoreCertificateUsingError' => [ + 'description' => '忽略证书使用错误。'."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'VerifyWay' => [ + 'description' => '验证方式。'."\n" + ."\n" + .'- 0：不验证 '."\n" + .'- 1：验证字符串 '."\n" + .'- 2：MD5验证', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'ValidateKeywords' => [ + 'description' => '验证关键词。', + 'type' => 'string', + 'example' => 'success', + ], + 'WhiteList' => [ + 'description' => 'DNS劫持白名单。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：`www.aliyun.com:203.0.3.55|203.3.44.67`，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + ], + ], + 'Website' => [ + 'description' => '网站测速类型任务配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '目标网址。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com', + ], + 'AutomaticScrolling' => [ + 'description' => '是否支持自动滚动屏幕，加载页面。0-否，1-是，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CustomHeader' => [ + 'description' => '自定义header。'."\n" + ."\n" + .'- 0：关（默认）'."\n" + .'- 1：修改第一包'."\n" + .'- 2：修改全部包', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义header，JSON Map格式。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}'."\n", + 'description' => 'JSON Map', + ], + ], + 'DisableCache' => [ + 'description' => '是否禁用缓存。'."\n" + .'- 0：不禁用'."\n" + .'- 1（默认）：禁用', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1'."\n", + ], + 'DisableCompression' => [ + 'description' => '通过Accept-Encoding字段判断是否接受压缩文件，0-不禁用，1-禁用，默认为0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FilterInvalidIP' => [ + 'description' => '是否过滤非有效IP。'."\n" + ."\n" + .'- 1：不过滤'."\n" + .'- 0：过滤'."\n", + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IgnoreCertificateError' => [ + 'description' => '是否忽略在SSL握手中证书校验过程中的证书错误而继续浏览。'."\n" + ."\n" + .'- 0：不忽略'."\n" + .'- 1（默认）：忽略', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时，单位为ms。非必填，默认20000。'."\n" + .'范围为5000~300000ms。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20000', + ], + 'Redirection' => [ + 'description' => '当出现重定向后，是否要继续浏览。'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1（默认）：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'SlowElementThreshold' => [ + 'description' => '慢元素阈值，单位为ms，默认5000，范围为1~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'WaitCompletionTime' => [ + 'description' => '最大等待完成时间，单位为ms，默认5000，范围为5000~300000ms。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5000', + ], + 'VerifyStringBlacklist' => [ + 'description' => '验证字符串即监测页面源代码中的某个任意字符串。若客户端返回的源码中包含任一黑名单中的字符串则报650验证字符串失败的错误。多个字符串以竖线（|）隔开。', + 'type' => 'string', + 'example' => 'error', + ], + 'VerifyStringWhitelist' => [ + 'description' => '验证字符串即监测页面源代码中的某个任意字符串。客户端返回的源码必须包含所有白名单中的字符串，否则报650验证字符串失败的错误。多个字符串以竖线（|）隔开。', + 'type' => 'string', + 'example' => 'success', + ], + 'ElementBlacklist' => [ + 'description' => '在页面加载过程中如果出现元素黑名单中配置的元素，不会请求加载该元素 。', + 'type' => 'string', + 'example' => 'www.example.com/a.jpg', + ], + 'DNSHijackWhitelist' => [ + 'description' => '域名（例如www.aliyun.com）解析时，解析出的IP地址或者CNAME不在DNS劫持白名单内，用户就会访问失败或者返回一个非Aliyun的目标IP；若解析结果中的IP或者CNAME在DNS白名单内，则会被认定为没有发生DNS劫持。'."\n" + ."\n" + .'填写格式：`域名:匹配规则`。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：`www.aliyun.com:203.0.3.55|203.3.44.67`，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + 'PageTamper' => [ + 'description' => '监测页面出现了域名设置之外的元素都属于页面被篡改。常见的表现形式为弹出广告、浮动广告、跳转等。'."\n" + ."\n" + .'填写格式：`域名:元素`。元素支持填写通配符，可以填写多个元素，多个元素以竖线（|）隔开。例如：`www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg`，表示www.aliyun.com域名下除基础文档、/cc/bb/a.gif和/vv/bb/cc.jpg之外的其他元素都属于页面被篡改。', + 'type' => 'string', + 'example' => 'www.aliyun.com:|/cc/bb/a.gif|/vv/bb/cc.jpg', + ], + 'FlowHijackJumpTimes' => [ + 'description' => '识别元素：设置浏览页面元素总个数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'FlowHijackLogo' => [ + 'description' => '劫持标识：设置匹配的关键信息。填写劫持判断关键字或关键元素，允许带星号（*）。', + 'type' => 'string', + 'example' => 'aliyun', + ], + ], + ], + 'Stream' => [ + 'description' => '流媒体拨测配置。', + 'type' => 'object', + 'properties' => [ + 'TargetUrl' => [ + 'description' => '流媒体资源地址。', + 'type' => 'string', + 'example' => 'http://www.aliyun.com/stream/test.mp4', + ], + 'StreamType' => [ + 'description' => '音视频标志：'."\n" + ."\n" + .'- 0：视频'."\n" + .'- 1：音频', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'StreamMonitorTimeout' => [ + 'description' => '监测时长，单位秒，最长支持60s，不传默认60。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '30', + ], + 'StreamAddressType' => [ + 'description' => '资源地址类型：'."\n" + ."\n" + .'- 1：资源地址。'."\n" + .'- 0：页面地址。不传默认0。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'PlayerType' => [ + 'description' => '播放器，不传默认12。'."\n" + ."\n" + .'- 12：VLC'."\n" + .'- 2：FlashPlayer', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'CustomHeaderContent' => [ + 'description' => '自定义header，JSON Map格式。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'description' => '自定义header，JSON Map格式。', + 'example' => '{'."\n" + .' "key1": "value1",'."\n" + .' "key2": "value2"'."\n" + .'}', + ], + ], + 'WhiteList' => [ + 'description' => 'DNS劫持白名单。匹配规则支持IP、IP通配符、子网掩码和CNAME，可以填写多个匹配规则，多个匹配规则以竖线（|）隔开。例如：`www.aliyun.com:203.0.3.55|203.3.44.67`，表示www.aliyun.com域名下除203.0.3.55和203.3.44.67之外的其他IP都是被劫持的。', + 'type' => 'string', + 'example' => 'www.aliyun.com:203.0.3.55|203.3.44.67', + ], + ], + ], + ], + ], + 'MonitorCategory' => [ + 'description' => '监测点类型：'."\n" + ."\n" + .'- 1：PC端'."\n" + .'- 2：移动端', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Monitors' => [ + 'description' => '监测点列表。', + 'type' => 'array', + 'items' => [ + 'description' => '监测点列表。', + 'type' => 'object', + 'properties' => [ + 'CityCode' => [ + 'description' => '城市编码。', + 'type' => 'string', + 'example' => '110100', + ], + 'OperatorCode' => [ + 'description' => '运营商编码。', + 'type' => 'string', + 'example' => '1', + ], + 'ClientType' => [ + 'description' => '拨测点客户端类型：'."\n" + ."\n" + .'- 1：IDC'."\n" + .'- 2：网民'."\n" + .'- 3：移动端'."\n" + .'- 4：云主机', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + ], + ], + ], + 'Frequency' => [ + 'description' => '拨测频率，可选范围：1m、5m、10m、15m、20m、30m、1h、2h、3h、4h、6h、8h、12h、24h。', + 'type' => 'string', + 'example' => '5m', + ], + 'CustomPeriod' => [ + 'description' => '自定义周期', + 'type' => 'object', + 'properties' => [ + 'EndHour' => [ + 'description' => '结束小时，0-24。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '22', + ], + 'StartHour' => [ + 'description' => '开始小时，0-24。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '14', + ], + ], + ], + 'CommonSetting' => [ + 'description' => '通用设置。', + 'type' => 'object', + 'properties' => [ + 'CustomHost' => [ + 'description' => '自定义host。', + 'type' => 'object', + 'properties' => [ + 'Hosts' => [ + 'description' => 'host列表。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义host。', + 'type' => 'object', + 'properties' => [ + 'Domain' => [ + 'description' => '域名。', + 'type' => 'string', + 'example' => 'www.aliyun.com', + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'Ips' => [ + 'description' => 'IP列表。', + 'type' => 'array', + 'items' => [ + 'description' => '对应的IP。', + 'type' => 'string', + 'example' => '10.0.114.17', + ], + ], + ], + ], + ], + 'SelectType' => [ + 'description' => '选择方式：'."\n" + ."\n" + .'- 0：随机'."\n" + .'- 1：轮询', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + ], + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'MonitorSamples' => [ + 'description' => '是否均匀分配监测样本 ：'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'IsOpenTrace' => [ + 'description' => '是否开启链路追踪。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'TraceClientType' => [ + 'description' => '链路追踪客户端类型：'."\n" + ."\n" + .'- 0：ARMS Agent'."\n" + .'- 1：OpenTelemetry'."\n" + .'- 2：Jaeger', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'XtraceRegion' => [ + 'description' => '链路数据上报region。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'CustomVPCSetting' => [ + 'description' => '用户VPC信息，如果拨测的是阿里云内网地址，需要配置VPC信息。', + 'type' => 'object', + 'properties' => [ + 'RegionId' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'VpcId' => [ + 'description' => 'VPC ID.', + 'type' => 'string', + 'example' => 'vpc-2zexy5nae9q2otaxxxx', + ], + 'VSwitchId' => [ + 'description' => '交换机ID。', + 'type' => 'string', + 'example' => 'vsw-bp1i0xezblf1yrz4xxxxx', + ], + 'SecureGroupId' => [ + 'description' => '安全组ID，此安全组是拨测客户端所在的安全组，安全组限定了拨测客户端在VPC中的出入站规则。需要设置您的VPC所在安全组的入站规则为允许拨测客户端所在的安全组访问。否则，拨测客户端无法顺畅地访问您的VPC内资源。', + 'type' => 'string', + 'example' => 'sg-xxxxxxx', + ], + ], + ], + 'CustomPrometheusSetting' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'properties' => [ + 'PrometheusLabels' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '保留字段。', + 'description' => '保留字段。', + ], + ], + 'PrometheusClusterId' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'example' => '保留字段。', + ], + 'PrometheusClusterRegion' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'example' => '保留字段。', + ], + ], + ], + ], + ], + 'AvailableAssertions' => [ + 'description' => '断言列表。', + 'type' => 'array', + 'items' => [ + 'description' => '断言列表。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '断言类型，包括：HttpResCode、HttpResHead、HttpResBody、HttpResBodyJson、HttpResponseTime、IcmpPackLoss（丢包率）、IcmpPackMaxLatency（最大包延时ms）、IcmpPackAvgLatency（平均延时）、TraceRouteHops（跃点数目）、DnsARecord（A记录）、DnsCName（Cname）、websiteTTFB（首包时间）、websiteTTLB（尾包时间）、websiteFST（首屏时间）、websiteFFST（首屏完全渲染时间）、websiteOnload（完全加载时间），具体使用见下文补充说明。', + 'type' => 'string', + 'example' => 'websiteTTLB', + ], + 'Target' => [ + 'description' => '检查目标，当为HttpResCode与HttpResBody、HttpResponseTime时，target不需要填，当为HttpResHead时，需指定header中的key，当为HttpResBodyJson时，使用jsonPath。', + 'type' => 'string', + 'example' => 'key'."\n", + ], + 'Operator' => [ + 'description' => '条件：'."\n" + ."\n" + .'- gt：大于'."\n" + .'- gte：大于等于'."\n" + .'- lt：小于'."\n" + .'- te：小于或等于'."\n" + .'- eq：等于'."\n" + .'- neq：不等于'."\n" + .'- ctn：包含'."\n" + .'- nctn：不包含'."\n" + .'- exist：存在'."\n" + .'- n_exist：不存在'."\n" + .'- belong：属于'."\n" + .'- n_belong：不属于'."\n" + .'- reg_match：正则匹配', + 'type' => 'string', + 'example' => 'gt', + ], + 'Expect' => [ + 'description' => '期望值。', + 'type' => 'string', + 'example' => '100', + ], + ], + ], + ], + 'Status' => [ + 'description' => '- CREATING：任务创建中'."\n" + .'- RUNNING：任务运行中'."\n" + .'- PARTIAL_RUNNING：任务部分运行中'."\n" + .'- STOP：任务停止'."\n" + .'- LIMIT_STOP：任务由于限额停止'."\n" + .'- EXCEPTION：任务异常'."\n" + .'- DELETE：任务删除'."\n" + .'- DELETE_EXCEPTION： 删除异常', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'default', + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的键。', + 'type' => 'string', + 'example' => 'user1', + ], + 'Value' => [ + 'description' => 'Tag的值', + 'type' => 'string', + 'example' => 'p_运维', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => [ + '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' => '获取拨测任务详情', + 'description' => '云拨测目前仅在杭州region提供服务，使用SDK或OpenAPI时请选择杭州region对应的服务接入点。', + ], + 'ListSyntheticDetail' => [ + 'summary' => '获取拨测结果。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID，当前只支持cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'SyntheticType', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测类型，必填，即时拨测：1，定时拨测：2。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Category', + 'in' => 'query', + 'schema' => [ + 'description' => '结果分类，必填，写死：SYNTHETIC。', + 'type' => 'string', + 'required' => false, + 'example' => 'SYNTHETIC', + ], + ], + [ + 'name' => 'Detail', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测结果内容，必填，获取不同类型的拨测结果传不同的值：'."\n" + ."\n" + .'- PING列表：ICMP_LIST'."\n" + .'- TCP列表：TCP_LIST'."\n" + .'- DNS列表：DNS_LIST'."\n" + .'- HTTP(s)列表：HTTP_LIST'."\n" + .'- 网站测速列表：WEBSITE_LIST'."\n" + .'- 文件下载列表：DOWNLOAD_LIST'."\n" + .'- 拨测结果明细：ALL', + 'type' => 'string', + 'required' => false, + 'example' => 'ICMP_LIST', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '筛选条件，必填。'."\n" + ."\n" + .'- 查任务拨测结果列表：{"taskId":"${taskId}"} '."\n" + .'- 查任务拨测结果详情：{"taskId":"${taskId}","dataId":"${dataId}"}', + 'type' => 'object', + 'required' => false, + 'additionalProperties' => [ + 'type' => 'string', + 'example' => '{"taskId":"xxxaaabbbcccdddeeefffggg"} ', + 'description' => '筛选条件。', + ], + ], + ], + [ + 'name' => 'AdvancedFilters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '筛选条件数组，必填。'."\n" + ."\n" + .'- 查询拨测结果列表：[{"Key":"taskType","OpType":"in","Value":[任务类型]}]。'."\n" + .'- 查询拨测结果详情：[{"Key":"dataId","OpType":"eq","Value":"dataId"}] ，dataId为查任务拨测结果列表返回值的dataId字段。', + 'type' => 'array', + 'items' => [ + 'description' => '筛选条件数组。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '筛选条件，支持taskType和dataId字段。'."\n" + ."\n" + .'- 查询拨测结果列表：taskType'."\n" + .'- 查询拨测结果详情：dataId', + 'type' => 'string', + 'required' => false, + 'example' => 'taskType', + ], + 'OpType' => [ + 'description' => '筛选类型，支持eq（等于）和in（包含）。', + 'type' => 'string', + 'required' => false, + 'example' => 'eq', + ], + 'Value' => [ + 'description' => '筛选条件的value。'."\n" + .'任务类型：'."\n" + .'1：ICMP；'."\n" + .'2：TCP；'."\n" + .'3：DNS；'."\n" + .'4：HTTP；'."\n" + .'5：网站测速；'."\n" + .'6：文件下载。', + 'type' => 'any', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'ExactFilters', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '保留字段。', + 'type' => 'array', + 'items' => [ + 'description' => '保留字段。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段。', + ], + 'OpType' => [ + 'description' => '保留字段。', + 'type' => 'string', + 'required' => false, + 'example' => '保留字段。', + ], + 'Value' => [ + 'description' => '保留字段。', + 'type' => 'any', + 'required' => false, + 'example' => '保留字段。', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询起始时间的时间戳，必填，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1684110343127', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结束时间的时间戳，必填，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1684480557772', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段，仅支持：timestamp（拨测发起时间）。', + 'type' => 'string', + 'required' => false, + 'example' => 'timestamp', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序标准。取值：'."\n" + ."\n" + .'- `ASC`：升序。'."\n" + .'- `DESC`：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'DESC', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页码，从1开始。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结果。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '70675725-8F11-4817-8106-CFE0AD71****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'null', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => '拨测结果列表。', + 'type' => 'array', + 'items' => [ + 'description' => '拨测结果列表。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '拨测结果列表记录或拨测详情记录。', + '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" + .'}', + ], + ], + ], + 'Total' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '12', + ], + 'Page' => [ + 'description' => '当前页数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TaskCreateTime' => [ + 'description' => '保留字段。', + 'type' => 'integer', + 'format' => 'int64', + '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' => [ + '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' => '获取拨测结果', + 'description' => '云拨测目前仅在杭州 region 提供服务，使用 SDK 或 OpenAPI 时请选择杭州 region 对应的服务接入点。', + 'requestParamsDescription' => '对拨测结果的查询一般分为两步，以查询PING类型任务的拨测结果为例。'."\n" + ."\n" + .'第一步：查询结果列表：'."\n" + ."\n" + .'{"SyntheticType":1,"RegionId":"cn-hangzhou","Category":"SYNTHETIC","Detail":"ICMP_LIST","Filters":{"taskId":"xxxx"},"AdvancedFilters":[{"Key":"taskType","OpType":"in","Value":[1]}],"StartTime":1710124284000,"EndTime":1710125544000,"Page":1,"PageSize":999}'."\n" + ."\n" + .'第二步：查询结果详情：'."\n" + ."\n" + .'{"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" + .'其中，$dataId替换成第一步查询拨测结果列表返回值的每一个记录中的dataId字段。', + ], + 'CreateSyntheticTask' => [ + 'summary' => '创建或更新云拨测定时任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。如果需要更新已创建的云拨测任务，此处填写已有的任务名称，并设置**UpdateTask**参数为**true**。', + 'type' => 'string', + 'required' => true, + 'example' => '网络拨测任务', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://www.example.com', + ], + ], + [ + 'name' => 'MonitorList', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '监测点列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CityCode' => [ + 'description' => '城市ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1100101', + ], + 'NetServiceId' => [ + 'description' => '运营商ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '18', + ], + 'MonitorType' => [ + 'description' => '运营商类型：'."\n" + ."\n" + .'- IDC'."\n" + .'- LastMilie', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => 'IDC', + ], + ], + 'required' => false, + ], + 'required' => true, + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'1. 3：网页性能-IE'."\n" + .'2. 34：网页性能-Chrome'."\n" + .'3. 0：网络质量'."\n" + .'4. 40：文件下载'."\n" + .'5. 7：API性能', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'IntervalTime', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测频率，单位为分钟。可选频率如下：'."\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', + 'type' => 'string', + 'required' => true, + 'example' => '5', + ], + ], + [ + 'name' => 'IntervalType', + 'in' => 'query', + 'schema' => [ + 'description' => '监测周期类型：'."\n" + ."\n" + .'- 0：每天'."\n" + .'- 1：自定义扩展频率', + 'type' => 'string', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'ExtendInterval', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '自定义扩展频率。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '周期开始时间。格式为`yyyy-MM-dd HH`。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-07-20 10', + ], + 'EndTime' => [ + 'description' => '周期结束时间 。格式为`yyyy-MM-dd HH`。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-08-20 10', + ], + 'Days' => [ + 'description' => '拨测执行周期。', + 'type' => 'array', + 'items' => [ + 'description' => '拨测执行周期。'."\n" + ."\n" + .'- -1：每天'."\n" + .'- 0：周日'."\n" + .'- 1：周一'."\n" + .'- 2：周二'."\n" + .'- 3：周三'."\n" + .'- 4：周四'."\n" + .'- 5：周五'."\n" + .'- 6：周六', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + 'required' => false, + ], + 'StartHour' => [ + 'description' => '当天开始拨测时间的小时数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '00', + ], + 'StartMinute' => [ + 'description' => '当天开始拨测时间的分钟数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '00', + ], + 'EndHour' => [ + 'description' => '当天结束拨测时间的小时数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '23', + ], + 'EndMinute' => [ + 'description' => '当天结束拨测时间的分钟数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '00', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'IpType', + 'in' => 'query', + 'schema' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '0', + ], + ], + [ + 'name' => 'Net', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '网络任务。', + 'type' => 'object', + 'properties' => [ + 'NetICMPSwitch' => [ + 'description' => 'Ping监测开关。'."\n" + ."\n" + .'- 0：关。'."\n" + .'- 1：开，开启后需设置ICMP参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NetICMPActive' => [ + 'description' => '协议类型：'."\n" + ."\n" + .'- 0：ICMP'."\n" + .'- 1：TCP ', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'NetICMPInterval' => [ + 'description' => '执行时间间隔。单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NetICMPNum' => [ + 'description' => 'Package数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '4', + ], + 'NetICMPSize' => [ + 'description' => 'Package大小。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '32', + ], + 'NetDNSSwitch' => [ + 'description' => 'DNS监测开关。'."\n" + ."\n" + .'- 0：关。'."\n" + .'- 1：开，开启后需设置DNS参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NetDNSTimeout' => [ + 'description' => 'DNS监测超时时间。默认值为5秒，取值范围为0~45秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '5', + ], + 'NetDNSQueryMethod' => [ + 'description' => 'DNS查询方式：'."\n" + ."\n" + .'- 1：递归'."\n" + .'- 2：迭代', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NetDNSNs' => [ + 'description' => '指定NS服务器。', + 'type' => 'string', + 'required' => false, + 'example' => '114.114.XX.XX', + ], + 'NetDigSwitch' => [ + 'description' => '是否以dig数据格式展示数据内容。'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'NetDNSServer' => [ + 'description' => 'DNS服务器类型：'."\n" + ."\n" + .'- 0：IPv4'."\n" + .'- 1：IPv6'."\n" + .'- 2：自动', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'NetTraceRouteSwitch' => [ + 'description' => 'Tracert监测开关。'."\n" + ."\n" + .'- 0：关。'."\n" + .'- 1：开，开启后需设置Tracert参数。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NetTraceRouteTimeout' => [ + 'description' => '监测超时，取值范围为0~300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '60', + ], + 'NetTraceRouteNum' => [ + 'description' => '最大活跃点数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'WhiteList' => [ + 'description' => "\n" + .'DNS劫持白名单。填写格式：`域名:匹配规则`。'."\n" + ."\n" + .'> WAP网络不支持劫持。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:202.0.3.55|203.3.44.67', + ], + 'NetICMPTimeout' => [ + 'description' => '监测超时取值范围。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '20', + ], + 'NetICMPDataCut' => [ + 'description' => '切分Package开关。'."\n" + ."\n" + .'- 0：关'."\n" + .'- 1：开'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'CommonParam', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '公共参数。', + 'type' => 'object', + 'properties' => [ + 'AlarmFlag' => [ + 'description' => '是否创建报警：'."\n" + ."\n" + .'- 1：创建报警'."\n" + .'- 0：不创建报警', + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'AlertList' => [ + 'description' => '告警参数。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '告警规则名称。'."\n" + ."\n" + .'网络拨测：'."\n" + ."\n" + .'- 时延：PING_SET'."\n" + .'- 丢包率：PING_LOST_RATE'."\n" + .'- 劫持：HIJACKPER', + 'type' => 'string', + 'required' => false, + 'example' => 'PING_SET', + ], + 'IsCritical' => [ + 'description' => '是否是必要条件。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => 'true', + ], + 'Symbols' => [ + 'description' => '条件判断：'."\n" + ."\n" + .'- 1：大于'."\n" + .'- 0：小于', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'AlertPolicyId' => [ + 'description' => '通知策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '1234', + ], + 'AlertNotifierId' => [ + 'description' => '告警联系人ID，多个联系人之间通过半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + 'StartExecutionTime' => [ + 'description' => '起始执行时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2022-07-20 10', + ], + 'MonitorSamples' => [ + 'description' => '是否均匀分配监测样本 ：'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Navigation', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '浏览任务监测关联项。', + 'type' => 'object', + 'properties' => [ + 'NavDisableCache' => [ + 'description' => '是否禁用缓存。'."\n" + ."\n" + .'- 1：禁用'."\n" + .'- 0：不禁用'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NavReturnElement' => [ + 'description' => '是否返回页面的元素。'."\n" + ."\n" + .'- 1：否，返回基础文档数据。'."\n" + .'- 2：是，返回所有文档数据。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + 'NavRedirection' => [ + 'description' => '当出现重定向后，是否要继续浏览。'."\n" + ."\n" + .'- 1：是'."\n" + .'- 0：否'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NavDisableCompression' => [ + 'description' => '通过Accept-Encoding字段判断是否接受压缩文件。'."\n" + ."\n" + .'- 1：禁用'."\n" + .'- 0：不禁用'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'NavAutomaticScrolling' => [ + 'description' => '是否支持自动滚动屏幕，加载页面。'."\n" + ."\n" + .'- 1：是'."\n" + .'- 0：否'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'NavIgnoreCertificateError' => [ + 'description' => '是否忽略在SSL握手中证书校验过程中的证书错误而继续浏览。'."\n" + ."\n" + .'- 1：忽略'."\n" + .'- 0：不忽略'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'FilterInvalidIP' => [ + 'description' => '是否过滤非有效IP。'."\n" + ."\n" + .'- 1：不过滤'."\n" + .'- 0：过滤'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'ExecuteApplication' => [ + 'description' => '是否执行Applet。'."\n" + ."\n" + .'- 1：执行'."\n" + .'- 0：不执行'."\n" + ."\n" + .'> 仅IE全元素支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'ExecuteActiveX' => [ + 'description' => '是否执行ActiveX。'."\n" + ."\n" + .'- 3：执行'."\n" + .'- 0：不执行'."\n" + ."\n" + .'> 仅IE全元素支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + 'ExecuteScript' => [ + 'description' => '是否执行脚本。'."\n" + ."\n" + .'- 1：执行'."\n" + .'- 0：不执行'."\n" + ."\n" + .'> 仅IE全元素支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'QUICVersion' => [ + 'description' => '设置QUIC版本。'."\n" + ."\n" + .'- 0（默认）'."\n" + .'- 35'."\n" + .'- 39'."\n" + .'- 43'."\n" + .'- 44'."\n" + ."\n" + .'> 仅Chrome全元素支持此参数。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'QUICDomain' => [ + 'description' => '输入QUIC请求元素域名。'."\n" + .'> 仅Chrome全元素支持此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com', + ], + 'RequestHeader' => [ + 'description' => '是否返回请求头。'."\n" + ."\n" + .'- 0：不返回'."\n" + .'- 1：返回基础文档Header'."\n" + .'- 2：返回所有Header'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'NavCustomHost' => [ + 'description' => '选择自定义Host模式。'."\n" + ."\n" + .'- 1：轮循'."\n" + .'- 0：随机'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'NavCustomHostIp' => [ + 'description' => '自定义Host IP。可以填写多个IP，每个IP用半角逗号（,）分隔。', + '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' => '自定义header。'."\n" + ."\n" + .'- 0：关'."\n" + .'- 1：修改第一包'."\n" + .'- 2：修改全部包', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + 'NavCustomHeaderContent' => [ + 'description' => '自定义Header格式。可以填写多个字段，多个字段以竖线（|）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'Host:www.example.com|Referer:www.example.com', + ], + 'ElementBlacklist' => [ + 'description' => '元素黑名单。', + 'type' => 'string', + 'required' => false, + 'example' => '*.a.com', + ], + 'ProcessName' => [ + 'description' => '进程标识。', + 'type' => 'string', + 'required' => false, + 'example' => 'ssh', + ], + 'VerifyStringBlacklist' => [ + 'description' => '验证字符串黑名单。截取页面代码中所包含的一段字符串，若检测样本中不包含则报错，支持正则表达配置格式【Regex:验证内容】，字符串黑名单多以"|"隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'Regex:*.example|expalme|', + ], + 'VerifyStringWhiteList' => [ + 'description' => '验证字符串白名单。截取页面代码中所包含的一段字符串，若检测样本中不包含则报错，支持正则表达配置格式【Regex:验证内容】，字符串白名单多以"|"隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'Regex:*.example|expalme|', + ], + 'MonitorTimeout' => [ + 'description' => '监测超时，单位为秒。', + 'type' => 'string', + 'required' => false, + 'example' => '20', + ], + 'WaitCompletionTime' => [ + 'description' => '等待完成时间，单位为秒。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '15', + ], + 'SlowElementThreshold' => [ + 'description' => '慢元素阈值，单位为秒。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '5', + ], + 'DNSHijackWhiteList' => [ + 'description' => 'DNS劫持白名单。填写格式：域名:匹配规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.aliyun.com:202.0.3.55|203.3.44.67', + ], + 'PageTamper' => [ + 'description' => '页面篡改。填写规则：冒号前部分为要判断的域名，冒号后部分为匹配规则；匹配规则支持确切IP\\ip通配符\\子网掩码\\cname，多个以竖线分割。', + 'type' => 'string', + 'required' => false, + 'example' => 'www.example.com:202.0.3.55|203.3.44.67', + ], + 'FlowHijackJumpTimes' => [ + 'description' => '识别元素。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '50', + ], + 'FlowHijackLogo' => [ + 'description' => '劫持标识。劫持判断关键字或关键元素，可以带星号（*）。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + 'ResponseHeader' => [ + 'description' => '返回响应头。'."\n" + ."\n" + .'- 0：不返回'."\n" + .'- 1：返回基础文档Header'."\n" + .'- 2：返回所有Header', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Download', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '文件下载任务。', + 'type' => 'object', + 'properties' => [ + 'DownloadTransmissionSize' => [ + 'description' => '传输大小，单位为KB。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10240', + ], + 'DownloadCustomHost' => [ + 'description' => '自定义Host。'."\n" + ."\n" + .'- 1：轮循'."\n" + .'- 0：随机'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'DownloadCustomHostIp' => [ + 'description' => '自定义Host IP。可以填写多个IP，每个IP用半角逗号（,）分隔。', + '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' => 'DNS劫持白名单。', + 'type' => 'string', + 'required' => false, + 'example' => '[{\\"src\\":\\"211.154.166.174\\"}]', + ], + 'DownloadKernel' => [ + 'description' => '下载内核。'."\n" + ."\n" + .'- 1：curl'."\n" + .'- 0：WinInet'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'QuickProtocol' => [ + 'description' => 'Quick协议'."\n" + ."\n" + .'- 1：http1'."\n" + .'- 2：http2'."\n" + .'- 3：http3'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + 'MonitorTimeout' => [ + 'description' => '监测时长。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '30', + ], + 'ConnectionTimeout' => [ + 'description' => '连接超时。', + 'type' => 'number', + 'format' => 'double', + 'required' => false, + 'example' => '200', + ], + 'VerifyWay' => [ + 'description' => '验证方式。'."\n" + ."\n" + .'- 0：不验证 '."\n" + .'- 1：验证字符串 '."\n" + .'- 2：MD5验证', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'ValidateKeywords' => [ + 'description' => '验证关键词。截取响应头中所包含的一段字符串，若监测样本中不包含则报错。', + 'type' => 'string', + 'required' => false, + 'example' => 'keyword', + ], + 'DownloadRedirection' => [ + 'description' => '是否支持重定向。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'DownloadCustomHeaderContent' => [ + 'description' => '自定义Header格式。可以填写多个字段，多个字段以竖线（|）隔开。', + 'type' => 'string', + 'required' => false, + 'example' => 'Host:www.example.com|Referer:www.example.com', + ], + 'DownloadIgnoreCertificateError' => [ + 'description' => '证书错误忽略内容。将复选框的值用竖线（|）拼接传递。复选框的值支持1:忽略证书状态错误;2:忽略证书不可信错误;4:忽略无效主机名错误。', + 'type' => 'string', + 'required' => false, + 'example' => '1|2|4', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'Protocol', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => 'API性能任务。', + 'type' => 'object', + 'properties' => [ + 'RequestContent' => [ + 'description' => '请求内容，包含Header和Body。'."\n", + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => '请求方法。'."\n" + ."\n" + .'- POST'."\n" + .'- GET'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'POST', + ], + 'Header' => [ + 'description' => '自定义发起API性能拨测时的请求Header。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Header的Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'regionId', + ], + 'Value' => [ + 'description' => 'Header的Value。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Body' => [ + 'description' => '自定义发起API性能拨测时的请求Body。', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'description' => '内容类型。'."\n" + ."\n" + .'- form-data'."\n" + .'- x-www-form-urlencoded'."\n" + .'- raw'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'form-data', + ], + 'FormData' => [ + 'description' => '**Mode**设置为**form-data**时传入的数据内容。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '**form-data**的Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'appId', + ], + 'Value' => [ + 'description' => '**form-data**的Value。', + 'type' => 'string', + 'required' => false, + 'example' => '3425', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'UrlEncoding' => [ + 'description' => '**Mode**设置为**x-www-form-urlencoded**时传入的数据内容。'."\n", + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '**x-www-form-urlencoded**的Key。', + 'type' => 'string', + 'required' => false, + 'example' => 'appId', + ], + 'Value' => [ + 'description' => '**x-www-form-urlencoded**的Value。', + 'type' => 'string', + 'required' => false, + 'example' => '11080', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + 'Raw' => [ + 'description' => '**Mode**设置为**raw**时传入的数据内容。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'content', + ], + 'Language' => [ + 'description' => 'Mode设置为raw时选择的语言。'."\n" + ."\n" + .'- json'."\n" + .'- xml'."\n" + .'- javascript'."\n" + .'- html'."\n" + .'- text', + 'type' => 'string', + 'required' => false, + 'example' => 'json', + ], + ], + 'required' => false, + ], + ], + 'required' => false, + ], + 'CharacterEncoding' => [ + 'description' => '字符编码。'."\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' => '验证响应内容。'."\n" + ."\n" + .'- 0：不验证'."\n" + .'- 1：字符串完全匹配'."\n" + .'- 2：字符串部分包含'."\n" + .'- 3：MD5验证'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + 'VerifyContent' => [ + 'description' => '验证内容。', + 'type' => 'string', + 'required' => false, + 'example' => '"code":200', + ], + 'ReceivedDataSize' => [ + 'description' => '接收数据大小。验证响应内容选择**部分包含**时填写。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '500', + ], + 'ProtocolMonitorTimeout' => [ + 'description' => '监测超时时间，单位为秒。', + 'type' => 'string', + 'required' => false, + 'example' => '30', + ], + 'CustomHost' => [ + 'description' => '自定义Host。'."\n" + ."\n" + .'- 1：轮循'."\n" + .'- 0：随机', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + 'CustomHostIp' => [ + 'description' => '自定义Host IP。可以填写多个IP，每个IP用半角逗号（,）分隔。', + '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' => '协议连接超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + 'required' => false, + ], + ], + [ + 'name' => 'UpdateTask', + 'in' => 'query', + 'schema' => [ + 'description' => '是否更新已有云拨测任务。'."\n" + ."\n" + .'- true：更新任务。'."\n" + .'- false：新建任务。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'Code' => [ + 'description' => '系统返回状态码：'."\n" + ."\n" + .'- 1001：请求成功'."\n" + .'- 1002：请求失败'."\n" + .'- 1003：参数错误'."\n" + .'- 1004：鉴权失败'."\n" + .'- 1006：任务不存在'."\n" + .'- 1099：内部错误', + 'type' => 'string', + 'example' => '1001', + ], + 'Msg' => [ + 'description' => '任务创建失败的返回说明。', + 'type' => 'string', + 'example' => 'null', + ], + 'Data' => [ + 'description' => '云拨测任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '云拨测任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建或更新云拨测任务', + ], + 'GetSyntheticTaskMonitors' => [ + 'summary' => '获取拨测点信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'Code' => [ + 'description' => '系统返回状态码：'."\n" + ."\n" + .'- 1001：请求成功'."\n" + .'- 1002：请求失败'."\n" + .'- 1003：参数错误'."\n" + .'- 1004：鉴权失败'."\n" + .'- 1006：任务不存在'."\n" + .'- 1099：内部错误', + 'type' => 'string', + 'example' => '1001', + ], + 'Msg' => [ + 'description' => '调用失败返回说明。', + 'type' => 'string', + 'example' => 'null', + ], + 'Data' => [ + 'description' => '监测点详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ClientType' => [ + 'description' => '客户端类型：'."\n" + ."\n" + .'- 1：IDC'."\n" + .'- 2：LASTMILE。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CityCode' => [ + 'description' => '城市ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1100101', + ], + 'City' => [ + 'description' => '城市名称。', + 'type' => 'string', + 'example' => '北京市', + ], + 'District' => [ + 'description' => '区域。', + 'type' => 'string', + 'example' => '北京', + ], + 'NetServiceId' => [ + 'description' => '运营商ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '18', + ], + 'NetServiceName' => [ + 'description' => '运营商名称。', + 'type' => 'string', + 'example' => 'XXX', + ], + 'Busy' => [ + 'description' => '任务活跃状态：'."\n" + ."\n" + .'- 0：活跃。'."\n" + .'- 1：繁忙。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取拨测点信息', + ], + 'SwitchSyntheticTaskStatus' => [ + 'summary' => '启动或者停止定时拨测任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务ID列表，最多一次指定30个。', + 'type' => 'array', + 'items' => [ + 'description' => '定时拨测任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '16720', + ], + 'required' => false, + 'maxItems' => 30, + ], + ], + [ + 'name' => 'SwitchStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '任务启停状态。取值：'."\n" + ."\n" + .'- **0**：停止任务。'."\n" + .'- **1**：开始任务。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '0', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Result' => [ + 'description' => '是否操作成功。'."\n" + ."\n" + .'- `true`：操作成功。'."\n" + .'- `false`：操作失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '启停拨测任务', + ], + 'GetSyntheticTaskList' => [ + 'summary' => '获取云拨测定时任务列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。默认为**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskType', + 'in' => 'query', + 'schema' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'1. 3：网页性能-IE'."\n" + .'2. 34：网页性能-Chrome'."\n" + .'3. 0：网络质量'."\n" + .'4. 40：文件下载'."\n" + .'5. 7：API性能', + 'type' => 'string', + 'required' => false, + 'example' => '0', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '拨测地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://www.example.com'."\n", + ], + ], + [ + 'name' => 'TaskName', + 'in' => 'query', + 'schema' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'net-test', + ], + ], + [ + 'name' => 'TaskStatus', + 'in' => 'query', + 'schema' => [ + 'description' => '任务启停状态。取值：'."\n" + ."\n" + .'- **0**：停止任务。'."\n" + .'- **1**：开始任务。'."\n" + .'- **9**：结束任务。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageNum', + 'in' => 'query', + 'schema' => [ + 'description' => '分页查询的页码。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的每页项目数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'CreateTime', + ], + ], + [ + 'name' => 'Direction', + 'in' => 'query', + 'schema' => [ + 'description' => '排序方向。取值：'."\n" + ."\n" + .'- **asc**：升序'."\n" + .'- **desc**：降序', + 'type' => 'string', + 'required' => false, + 'example' => 'asc', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'PageInfo' => [ + 'description' => '查询结果页面。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '查询结果总条数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'List' => [ + 'description' => '任务列表信息。', + 'type' => 'array', + 'items' => [ + 'description' => '定时任务信息。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'example' => '2118709', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'net-test', + ], + 'Url' => [ + 'description' => '定时拨测任务地址。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'TaskType' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'1. 3：网页性能-IE'."\n" + .'2. 34：网页性能-Chrome'."\n" + .'3. 0：网络质量'."\n" + .'4. 40：文件下载'."\n" + .'5. 7：API性能', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'TaskTypeName' => [ + 'description' => '任务类型名称', + 'type' => 'string', + 'example' => '网络质量', + ], + 'MonitorNumber' => [ + 'description' => '检测点数量', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + 'TaskStatus' => [ + 'description' => '任务启停状态。取值：'."\n" + ."\n" + .'- **0**：停止任务。'."\n" + .'- **1**：开始任务。'."\n" + .'- **9**：结束任务。'."\n", + 'type' => 'string', + 'example' => '0', + ], + 'Usable' => [ + 'description' => '可用性，只统计最近一天的数据，如果最近一天没数据，返回空。', + 'type' => 'number', + 'format' => 'float', + 'example' => '0.80', + ], + 'CreateTime' => [ + 'description' => '任务创建时间。', + 'type' => 'string', + 'example' => '1634005438000', + ], + ], + ], + ], + 'Size' => [ + 'description' => '每页展示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Pages' => [ + 'description' => '总页数。', + 'type' => 'string', + 'example' => '10', + ], + 'Prepage' => [ + 'description' => '前一页。', + 'type' => 'string', + 'example' => '1', + ], + 'NextPage' => [ + 'description' => '后一页。', + 'type' => 'string', + 'example' => '3', + ], + 'IsFirstPage' => [ + 'description' => '是否为第一页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'IsLastPage' => [ + 'description' => '是否为最后一页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HasPreviousPage' => [ + 'description' => '是否有前一页。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'HasNextPage' => [ + 'description' => '是否有下一页。', + 'type' => 'string', + 'example' => 'false', + ], + 'NavigatePageNums' => [ + 'description' => '所有导航页号。', + 'type' => 'string', + 'example' => '1,2,3', + ], + 'NavigateFirstPage' => [ + 'description' => '导航条上的第一页。', + 'type' => 'string', + 'example' => '1', + ], + 'NavigateLastPage' => [ + 'description' => '导航条上的最后一页。', + 'type' => 'string', + 'example' => '3', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取拨测任务列表', + ], + 'GetSyntheticTaskDetail' => [ + 'summary' => '根据任务ID获取定时拨测任务的详情。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskId', + 'in' => 'query', + 'schema' => [ + 'description' => '云拨测任务ID。', + 'type' => 'string', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'TaskDetail' => [ + 'description' => '任务详情。', + 'type' => 'object', + 'properties' => [ + 'TaskId' => [ + 'description' => '云拨测任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '19584', + ], + 'TaskName' => [ + 'description' => '任务名称。', + 'type' => 'string', + 'example' => 'net-test', + ], + 'Url' => [ + 'description' => '拨测地址。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'MonitorList' => [ + 'description' => '检测点列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'CityCode' => [ + 'description' => '城市编码。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '11011XX', + ], + 'NetServiceId' => [ + 'description' => '网络服务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'MonitorType' => [ + 'description' => '监测点类型。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'SendCount' => [ + 'description' => '发送次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2', + ], + ], + ], + ], + 'TaskType' => [ + 'description' => '任务类型：'."\n" + ."\n" + .'1. 3：网页性能-IE'."\n" + .'2. 34：网页性能-Chrome'."\n" + .'3. 0：网络质量'."\n" + .'4. 40：文件下载'."\n" + .'5. 7：API性能', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'IntervalTime' => [ + 'description' => '拨测频率，单位为分钟。可选频率如下：'."\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', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'IntervalType' => [ + 'description' => '监测周期类型：'."\n" + ."\n" + .'- 0：每天'."\n" + .'- 1：自定义扩展频率', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ExtendInterval' => [ + 'description' => '自定义扩展频率。', + 'type' => 'object', + 'properties' => [ + 'StartTime' => [ + 'description' => '周期开始时间，格式yyyy-MM-dd HH', + 'type' => 'string', + 'example' => '2022-02-26 11:40', + ], + 'EndTime' => [ + 'description' => '周期结束时间 。格式为`yyyy-MM-dd HH`。', + 'type' => 'string', + 'example' => '2022-05-03 11:40', + ], + 'Days' => [ + 'description' => '拨测执行周期。'."\n" + ."\n" + .'- -1：每天'."\n" + .'- 0：周日'."\n" + .'- 1：周一'."\n" + .'- 2：周二'."\n" + .'- 3：周三'."\n" + .'- 4：周四'."\n" + .'- 5：周五'."\n" + .'- 6：周六', + 'type' => 'array', + 'items' => [ + 'description' => '拨测执行日期。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + ], + 'StartHour' => [ + 'description' => '当天开始拨测时间的小时数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '9', + ], + 'StartMinute' => [ + 'description' => '当天开始拨测时间的分钟数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Endhour' => [ + 'description' => '当天结束小时数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'EndMinute' => [ + 'description' => '当天结束分钟数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + ], + ], + 'IpType' => [ + 'description' => 'IP类型：'."\n" + ."\n" + .'- 0：自动'."\n" + .'- 1：IPv4'."\n" + .'- 2：IPpv6', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'Download' => [ + 'description' => '文件下载任务。', + 'type' => 'object', + 'properties' => [ + 'DownloadTransmissionSize' => [ + 'description' => '传输大小，单位为KB。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'DownloadCustomHost' => [ + 'description' => '自定义Host。'."\n" + ."\n" + .'- 1：轮循'."\n" + .'- 0：随机'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DownloadCustomHostIp' => [ + 'description' => '自定义Host IP。可以填写多个IP，每个IP用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '168.23.45.1', + ], + 'WhiteList' => [ + 'description' => "\n" + .'DNS劫持白名单。填写格式：`域名:匹配规则`。'."\n" + ."\n" + .'> WAP网络不支持劫持。', + 'type' => 'string', + 'example' => '[{\\"src\\":\\"211.154.166.174\\"}]', + ], + 'DownloadKernel' => [ + 'description' => '下载内核。'."\n" + ."\n" + .'- 1：curl'."\n" + .'- 0：WinInet'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'QuickProtocol' => [ + 'description' => 'Quick协议'."\n" + ."\n" + .'- 1：http1'."\n" + .'- 2：http2'."\n" + .'- 3：http3'."\n", + 'type' => 'string', + 'example' => '1', + ], + 'MonitorTimeout' => [ + 'description' => '监测时长。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'ConnectionTimeout' => [ + 'description' => '下载任务超时时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'VerifyWay' => [ + 'description' => '验证响应内容。'."\n" + ."\n" + .'- 0：不验证'."\n" + .'- 1：字符串完全匹配'."\n" + .'- 2：字符串部分包含'."\n" + .'- 3：MD5验证'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'ValidateKeywords' => [ + 'description' => '验证关键词。', + 'type' => 'string', + 'example' => 'test', + ], + 'DownloadRedirect' => [ + 'description' => '是否支持重定向。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'DownloadCustomHeaderContent' => [ + 'description' => '证书错误忽略内容。将复选框的值用竖线‘｜’拼接传递。'."\n", + 'type' => 'string', + 'example' => 'char', + ], + ], + ], + 'Net' => [ + 'description' => '网络任务。', + 'type' => 'object', + 'properties' => [ + 'NetIcmpSwitch' => [ + 'description' => 'Ping监测开关。'."\n" + ."\n" + .'- 0：关'."\n" + .'- 1：开，当设置为1时还需设置Icmp参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetIcmpActive' => [ + 'description' => '协议类型'."\n" + .'- 0 : ICMP'."\n" + .'- 1 : TCP', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetIcmpTimeout' => [ + 'description' => '监测超时时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'NetIcmpInterval' => [ + 'description' => '拨测任务执行间隔。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'NetIcmpNum' => [ + 'description' => 'Package数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'NetIcmpSize' => [ + 'description' => 'Package大小。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'NetIcmpDataCut' => [ + 'description' => '切分package开关，取值：'."\n" + .'- 0: 关'."\n" + .'- 1: 开', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetDnsQueryMethod' => [ + 'description' => 'DNS查询方式，取值：'."\n" + .'- 1: 递归'."\n" + .'- 2: 迭代', + 'type' => 'string', + 'example' => '1', + ], + 'NetDnsSwitch' => [ + 'description' => 'DNS监测开关，取值：'."\n" + .'- 0: 关'."\n" + .'- 1: 开', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetTraceRouteSwitch' => [ + 'description' => 'Tracert监测开关。'."\n" + ."\n" + .'- 0：关。'."\n" + .'- 1：开，开启后需设置Tracert参数。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetTraceRouteTimeout' => [ + 'description' => '监测超时，取值范围为0~300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'NetTraceRouteNum' => [ + 'description' => '最大活跃点数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'WhiteList' => [ + 'description' => "\n" + .'DNS劫持白名单。填写格式：`域名:匹配规则`。'."\n" + ."\n" + .'> WAP网络不支持劫持。', + 'type' => 'string', + 'example' => '119.119.53.156/32', + ], + 'NetDnsNs' => [ + 'description' => '指定NS服务器。', + 'type' => 'string', + 'example' => '189.12.32.124', + ], + 'NetDigSwitch' => [ + 'description' => '是否以dig数据格式展示数据内容。'."\n" + ."\n" + .'- 0：否'."\n" + .'- 1：是'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetDnsServer' => [ + 'description' => 'DNS服务器类型，取值：'."\n" + .'- 0: ipv4'."\n" + .'- 1: ipv6'."\n" + .'- 2: 自动', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NetDnsTimeout' => [ + 'description' => '网络DNS超时时间。', + 'type' => 'string', + 'example' => '10', + ], + ], + ], + 'Nav' => [ + 'description' => '浏览任务。', + 'type' => 'object', + 'properties' => [ + 'NavDisableCache' => [ + 'description' => '是否禁用缓存。'."\n" + ."\n" + .'- 1：禁用'."\n" + .'- 0：不禁用'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NavReturnElement' => [ + 'description' => '是否返回页面的元素。'."\n" + ."\n" + .'- 1：否，返回基础文档数据。'."\n" + .'- 2：是，返回所有文档数据。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NavRedirect' => [ + 'description' => '重定向，取值：'."\n" + .'- 0: 否'."\n" + .'- 1: 是', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NavDisableCompression' => [ + 'description' => '禁用压缩，取值：'."\n" + .'- 0: 不禁用'."\n" + .'- 1: 禁用', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NavAutomaticScrolling' => [ + 'description' => '是否支持自动滚动屏幕，加载页面。'."\n" + ."\n" + .'- 1：是'."\n" + .'- 0：否'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NavIgnoreCertificateError' => [ + 'description' => '是否忽略在SSL握手中证书校验过程中的证书错误而继续浏览。'."\n" + ."\n" + .'- 1：忽略'."\n" + .'- 0：不忽略'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'FilterInvalidIP' => [ + 'description' => '是否过滤非有效IP。'."\n" + ."\n" + .'- 1：不过滤'."\n" + .'- 0：过滤'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteApplet' => [ + 'description' => '执行Applet，取值：'."\n" + .'- 0: 不执行'."\n" + .'- 1: 执行', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'ExecuteActiveX' => [ + 'description' => '是否执行ActiveX。'."\n" + ."\n" + .'- 3：执行'."\n" + .'- 0：不执行'."\n" + ."\n" + .'> 仅IE全元素支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'ExecuteScript' => [ + 'description' => '是否执行脚本。'."\n" + ."\n" + .'- 1：执行'."\n" + .'- 0：不执行'."\n" + ."\n" + .'> 仅IE全元素支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'QuicVersion' => [ + 'description' => 'quic版本，默认0。'."\n" + ."\n" + .'- 35：35'."\n" + .'- 39: 39'."\n" + .'- 43: 43'."\n" + .'- 44: 44'."\n" + ."\n" + .'> 仅Chrome全元素支持此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'QuicDomain' => [ + 'description' => 'quic请求元素域名。', + 'type' => 'string', + 'example' => 'www.example.com', + ], + 'RequestHeader' => [ + 'description' => '返回请求头。'."\n" + .'- 0：不返回'."\n" + .'- 1：返回基础文档Header'."\n" + .'- 2：返回所有的Header ', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'NavCustomHost' => [ + 'description' => '选择自定义Host模式。'."\n" + ."\n" + .'- 1：轮循'."\n" + .'- 0：随机'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'NavCustomHostIp' => [ + 'description' => '自定义Host IP。可以填写多个IP，每个IP用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '119.119.53.156/32', + ], + 'NavCustomHeader' => [ + 'description' => '自定义header。'."\n" + ."\n" + .'- 0：关'."\n" + .'- 1：修改第一包'."\n" + .'- 2：修改全部包', + 'type' => 'string', + 'example' => '0', + ], + 'NavCustomHeaderContent' => [ + 'description' => '自定义Header格式。可以填写多个字段，多个字段以竖线（）隔开。', + 'type' => 'string', + 'example' => 'content', + ], + 'ElementBlacklist' => [ + 'description' => '元素黑名单。', + 'type' => 'string', + 'example' => 'test', + ], + 'ProcessName' => [ + 'description' => '进程标识。', + 'type' => 'string', + 'example' => 'ssh', + ], + 'VerifyStringBlacklist' => [ + 'description' => '验证字符串黑名单。', + 'type' => 'string', + 'example' => 'test', + ], + 'VerifyStringWhitelist' => [ + 'description' => '验证字符串白名单。', + 'type' => 'string', + 'example' => 'test', + ], + 'MonitorTimeout' => [ + 'description' => '监控超时时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'WaitCompletionTime' => [ + 'description' => '等待完成时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SlowElementThreshold' => [ + 'description' => '慢元素阈值，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'DnsHijackWhitelist' => [ + 'description' => 'dns白名单列表。', + 'type' => 'string', + 'example' => '119.119.53.156', + ], + 'PageTampering' => [ + 'description' => '页面篡改。', + 'type' => 'string', + 'example' => 'content', + ], + 'FlowHijackJumpTimes' => [ + 'description' => '识别元素。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12', + ], + 'FlowHijackLogo' => [ + 'description' => '劫持标识。', + 'type' => 'string', + 'example' => 'target', + ], + ], + ], + 'Protocol' => [ + 'description' => 'API性能类型的拨测任务。', + 'type' => 'object', + 'properties' => [ + 'RequestContent' => [ + 'description' => '请求内容（包含Header、Body）。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'description' => '请求方法。'."\n" + ."\n" + .'- POST'."\n" + .'- GET'."\n", + 'type' => 'string', + 'example' => 'POST', + ], + 'Header' => [ + 'description' => '请求头。', + 'type' => 'array', + 'items' => [ + 'description' => '头信息', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '请求参数中header的key', + 'type' => 'string', + 'example' => 'regionId', + ], + 'Value' => [ + 'description' => '请求参数中header的值', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + 'Body' => [ + 'description' => '请求body内容', + 'type' => 'object', + 'properties' => [ + 'Mode' => [ + 'description' => '内容类型。'."\n" + ."\n" + .'- form-data'."\n" + .'- x-www-form-urlencoded'."\n" + .'- raw'."\n", + 'type' => 'string', + 'example' => 'form-data', + ], + 'Formdata' => [ + 'description' => 'mode=form-data时传入的数据内容。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '**form-data**的Key。', + 'type' => 'string', + 'example' => 'appId', + ], + 'Value' => [ + 'description' => 'form-data的value。', + 'type' => 'string', + 'example' => '3425', + ], + ], + ], + 'Urlencoded' => [ + 'description' => 'Body内容的URLl地址.', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的键。', + 'type' => 'string', + 'example' => 'appId', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => '11080', + ], + ], + ], + 'Raw' => [ + 'description' => '**Mode**设置为**raw**时传入的数据内容。'."\n", + 'type' => 'string', + 'example' => 'content', + ], + 'Language' => [ + 'description' => 'Mode设置为raw时选择的语言。'."\n" + ."\n" + .'- json'."\n" + .'- xml'."\n" + .'- javascript'."\n" + .'- html'."\n" + .'- text', + 'type' => 'string', + 'example' => 'xml', + ], + ], + ], + ], + ], + 'CharacterEncoding' => [ + 'description' => '字符编码。'."\n" + ."\n" + .'- 0：utf-8'."\n" + .'- 1：gbk'."\n" + .'- 2：gb2312'."\n" + .'- 3：unicode'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'VerifyWay' => [ + 'description' => '验证响应内容。'."\n" + ."\n" + .'- 0：不验证'."\n" + .'- 1：字符串完全匹配'."\n" + .'- 2：字符串部分包含'."\n" + .'- 3：MD5验证'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'VerifyContent' => [ + 'description' => '验证内容。', + 'type' => 'string', + 'example' => 'list', + ], + 'ReceivedDataSize' => [ + 'description' => '接收数据大小。验证响应内容选择**部分包含**时填写。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'ProtocolMonitorTimeout' => [ + 'description' => '监测超时时间，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + 'ProtocolConnectionTimeout' => [ + 'description' => '超时时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'CustomHost' => [ + 'description' => '自定义Host。'."\n" + ."\n" + .'- 1：轮循'."\n" + .'- 0：随机', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'CustomHostIp' => [ + 'description' => '自定义Host IP。可以填写多个IP，每个IP用半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '119.119.53.156', + ], + ], + ], + 'MonitorListString' => [ + 'description' => '监测点列表字符串。', + 'type' => 'string', + 'example' => '12', + ], + 'CommonParam' => [ + 'description' => '通用参数列表。', + 'type' => 'object', + 'properties' => [ + 'AlarmFlag' => [ + 'description' => '告警标识符。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'AlertPolicyId' => [ + 'description' => '报警策略ID。', + 'type' => 'string', + 'example' => '1', + ], + 'AlertNotifierId' => [ + 'description' => '报警标识符ID。', + 'type' => 'string', + 'example' => '1', + ], + 'StartExecutionTime' => [ + 'description' => '开始执行时间。', + 'type' => 'string', + 'example' => '1664427128', + ], + 'MonitorSamples' => [ + 'description' => '监测样本。', + 'type' => 'string', + 'example' => '1', + ], + 'AlertList' => [ + 'description' => '报警列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '报警名称。', + 'type' => 'string', + 'example' => 'alert-test', + ], + 'GeneralAlert' => [ + 'description' => '普通报警。', + 'type' => 'string', + 'example' => '1', + ], + 'SeriousAlert' => [ + 'description' => '严重报警。', + 'type' => 'string', + 'example' => '1', + ], + 'IsCritical' => [ + 'description' => '是否是必要条件。', + 'type' => 'string', + 'example' => '0', + ], + 'Symbols' => [ + 'description' => '大于或小于。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取定时拨测任务的详情', + ], + 'DeleteSyntheticTask' => [ + 'summary' => '删除云拨测定时任务。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'TaskIds', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '任务ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '定时拨测任务ID，任务的唯一标识。', + 'type' => 'string', + 'required' => false, + 'example' => '16720', + ], + 'required' => true, + 'maxItems' => 30, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A9C645C-C83F-4C9D-8CCB-29BEC9E1****', + ], + 'Result' => [ + 'description' => '是否删除成功。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'string', + 'example' => 'true', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A9C645C-C83F-4C9D-8CCB-29BEC9E1****\\",\\n \\"Result\\": \\"true\\"\\n}","type":"json"}]', + 'title' => '删除拨测任务', + ], + 'CreateIntegration' => [ + 'summary' => '创建告警集成。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'IntegrationName', + 'in' => 'formData', + 'schema' => [ + 'title' => '集成名称', + 'description' => '集成名称。', + 'type' => 'string', + 'required' => true, + 'example' => '云监控集成', + ], + ], + [ + 'name' => 'IntegrationProductType', + 'in' => 'formData', + 'schema' => [ + 'title' => '集成产品类型', + 'description' => '集成产品类型：'."\n" + ."\n" + .'- CLOUD_MONITOR：云监控'."\n" + .'- LOG_SERVICE：日志服务', + 'type' => 'string', + 'required' => true, + 'example' => 'CLOUD_MONITOR', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'title' => '集成描述', + 'description' => '集成描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'AutoRecover', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否开启恢复，默认true', + 'description' => '告警事件是否自动恢复：'."\n" + ."\n" + .'- true（默认）'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RecoverTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '恢复时间，默认300s', + 'description' => '告警事件自动恢复时间，默认时间为300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'Integration' => [ + 'description' => '返回的告警集成信息。', + 'type' => 'object', + 'properties' => [ + 'IntegrationId' => [ + 'title' => '集成ID', + 'description' => '告警集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'IntegrationName' => [ + 'title' => '集成名称', + 'description' => '告警集成名称。', + 'type' => 'string', + 'example' => '云监控集成', + ], + 'IntegrationProductType' => [ + 'title' => '集成产品类型', + 'description' => '集成产品类型：'."\n" + ."\n" + .'- CLOUD_MONITOR：云监控'."\n" + .'- LOG_SERVICE：日志服务', + 'type' => 'string', + 'example' => 'CLOUD_MONITOR', + ], + 'Description' => [ + 'title' => '集成描述', + 'description' => '告警集成描述信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'AutoRecover' => [ + 'title' => '是否开启恢复，默认true', + 'description' => '告警事件是否自动恢复：'."\n" + ."\n" + .'- true（默认）'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecoverTime' => [ + 'title' => '恢复时间，默认300s', + 'description' => '告警事件自动恢复时间，默认时间为300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建告警集成', + ], + 'UpdateIntegration' => [ + 'summary' => '修改集成相关信息。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'write', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'IntegrationId', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'IntegrationName', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警集成名称。', + 'type' => 'string', + 'required' => true, + 'example' => '云监控集成', + ], + ], + [ + 'name' => 'IntegrationProductType', + 'in' => 'formData', + 'schema' => [ + 'description' => '集成产品类型：'."\n" + ."\n" + .'- CLOUD_MONITOR：云监控'."\n" + .'- LOG_SERVICE：日志服务', + 'type' => 'string', + 'required' => true, + 'example' => 'CLOUD_MONITOR', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警集成描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => '测试', + ], + ], + [ + 'name' => 'AutoRecover', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警事件是否自动恢复：'."\n" + ."\n" + .'- true（默认）'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RecoverTime', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警事件自动恢复时间，默认时间为300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '300', + ], + ], + [ + 'name' => 'DuplicateKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '去重的字段。', + 'type' => 'string', + 'required' => false, + 'example' => 'LABEL.dimensions::LABEL.ruleId', + ], + ], + [ + 'name' => 'State', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警集成是否启用：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Stat', + 'in' => 'formData', + 'schema' => [ + 'description' => '最近1小时总数及异常数。', + 'type' => 'string', + 'required' => false, + 'example' => '[0,0]', + ], + ], + [ + 'name' => 'Liveness', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警集成活跃度。', + 'type' => 'string', + 'required' => false, + 'example' => 'ready', + ], + ], + [ + 'name' => 'FieldRedefineRules', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件映射，将源字段映射到目标字段。'."\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" + .']', + ], + ], + [ + 'name' => 'ExtendedFieldRedefineRules', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件映射，将源字段映射到目标字段，拓展字段增加映射。更多信息，请参见下方补充说明。', + '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" + .']', + ], + ], + [ + 'name' => 'InitiativeRecoverField', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警事件恢复字段。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。'."\n" + ."\n" + .'> 仅日志服务支持设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => '$.status', + ], + ], + [ + 'name' => 'InitiativeRecoverValue', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警事件恢复字段值。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。'."\n" + .'> 仅日志服务支持设置此参数。', + 'type' => 'string', + 'required' => false, + 'example' => 'ok', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'Integration' => [ + 'description' => '集成信息。', + 'type' => 'object', + 'properties' => [ + 'IntegrationId' => [ + 'description' => '告警集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'IntegrationName' => [ + 'description' => '告警集成名称。', + 'type' => 'string', + 'example' => '云监控集成', + ], + 'IntegrationProductType' => [ + 'description' => '集成产品类型：'."\n" + ."\n" + .'- CLOUD_MONITOR：云监控'."\n" + .'- LOG_SERVICE：日志服务', + 'type' => 'string', + 'example' => 'CLOUD_MONITOR', + ], + 'Description' => [ + 'description' => '告警集成描述信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'ApiEndpoint' => [ + 'description' => '集成地址。', + 'type' => 'string', + 'example' => 'https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******', + ], + 'ShortToken' => [ + 'description' => '集成Token。', + 'type' => 'string', + 'example' => 'ymQBN******', + ], + 'AutoRecover' => [ + 'description' => '告警事件是否自动恢复：'."\n" + ."\n" + .'- true（默认）'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecoverTime' => [ + 'description' => '告警事件自动恢复时间，默认时间为300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'DuplicateKey' => [ + 'description' => '去重的字段。', + 'type' => 'string', + 'example' => 'LABEL.dimensions::LABEL.ruleId', + ], + 'State' => [ + 'description' => '告警集成是否启用：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Stat' => [ + 'description' => '最近1小时总数及异常数。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '最近1小时总数及异常数。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[0,0]', + ], + ], + 'Liveness' => [ + 'description' => '告警集成活跃度。', + 'type' => 'string', + 'example' => 'ready', + ], + 'FieldRedefineRules' => [ + 'description' => '固定映射字段。', + 'type' => 'array', + 'items' => [ + 'description' => ' '."\n" + .'事件映射，将源字段映射到目标字段。'."\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" + .']', + ], + ], + 'ExtendedFieldRedefineRules' => [ + 'description' => '拓展映射字段。', + 'type' => 'array', + 'items' => [ + 'description' => '事件映射，将源字段映射到目标字段，拓展字段增加映射。', + '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' => '告警事件恢复字段。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。'."\n" + .'> 仅日志服务支持此参数。', + 'type' => 'string', + 'example' => '$.status', + ], + 'InitiativeRecoverValue' => [ + 'description' => '告警事件恢复字段值。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。'."\n" + .'> 仅日志服务支持此参数。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + ], + ], + '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' => '修改集成相关信息', + 'requestParamsDescription' => '### FieldRedefineRules和ExtendedFieldRedefineRules参数说明'."\n" + .'完整示例如下：'."\n" + ."\n" + .'```'."\n" + .'['."\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":"imageUrl",'."\n" + .' "expression":null,'."\n" + .' "mappingRuleList":['."\n" + ."\n" + .' ],'."\n" + .' "name":"告警图片",'."\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":"检查项",'."\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":"来源",'."\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":"分类",'."\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":"服务",'."\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":"开始时间",'."\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":"结束时间",'."\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":"事件地址",'."\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" + .'字段说明：'."\n" + .'|字段|说明|'."\n" + .'|---|---|'."\n" + .'|RedefineType|- MAP：通过映射表进行字段映射，如告警等级映射。<br />- EXTRACT：通过jsonPath从JSON中解析一个字段映射到目标字段。<br />- ADD：添加一个内容映射到目标字段。<br />- CONDITION：条件映射。当满足条件时，通过jsonPath从JSON中解析一个字段映射到目标字段。<br />- CONCAT：串联映射。将多个字段以指定的串联符合拼接在一起后映射到模板字段。<br />|'."\n" + .'|MatchExpression|- 如果RedefineType设置为CONCAT，MatchExpression的值即为传递串联的分隔符。<br />- 如果RedefineType设置为CONDITION，MatchExpression的值即为传递条件规则的JSON字符串。|'."\n" + .'|FieldType|- LABEL：告警元数据，一组标签唯一标识一个事件，标签相同的事件为同一个事件，重复上报会进行合并，常见的标签如 “alertname: 告警名称 ”。<br />- ANNOTATION：注释是告警事件的附加描述，注释不属于元数据。常见的注释有 “message: 告警内容”。<br />- GENERATE_URL：事件URL地址。<br />- START_AT：告警事件开始时间。<br />- END_AT：告警事件结束时间。|'."\n" + .'|Expression|条件映射样式，作为转义字符串值存入Expression。|'."\n" + .'|MappingRuleList|字段重定义规则。|'."\n" + .'|Name|名称。|'."\n" + .'|FieldName|字段名称。|'."\n" + .'|JsonPath|源字段名称。|'."\n" + .'|IntegrationId|集成ID。|'."\n" + .'|Id|映射字段存储表主键ID。|', + ], + 'DeleteIntegrations' => [ + 'summary' => '删除指定告警集成。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'IntegrationId', + 'in' => 'query', + 'schema' => [ + 'title' => '集成ID', + 'description' => '告警集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'IsSuccess' => [ + 'title' => '删除成功或者失败', + 'description' => '是否成功删除：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除指定告警集成', + ], + 'ListIntegration' => [ + 'summary' => '查看集成列表详情。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'IntegrationName', + 'in' => 'query', + 'schema' => [ + 'title' => '集成名称', + 'description' => '告警集成名称。', + 'type' => 'string', + 'required' => false, + 'example' => '云监控集成', + ], + ], + [ + 'name' => 'IntegrationProductType', + 'in' => 'query', + 'schema' => [ + 'title' => '集成产品类型，CLOUD_MONITOR，LOG_SERVICE', + 'description' => '集成产品类型：'."\n" + ."\n" + .'- CLOUD_MONITOR：云监控'."\n" + .'- LOG_SERVICE：日志服务', + 'type' => 'string', + 'required' => true, + 'example' => 'CLOUD_MONITOR', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '条数', + 'description' => '每页展示的告警集成数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '10', + ], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => [ + 'title' => '是否展示详情', + 'description' => '是否展示集成详情：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'PageInfo' => [ + 'title' => '分页信息', + 'description' => '分页信息。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的告警集成总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '条数', + 'description' => '每页展示数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Integrations' => [ + 'description' => '告警集成信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'IntegrationId' => [ + 'title' => '集成ID', + 'description' => '集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'IntegrationName' => [ + 'title' => '集成名称', + 'description' => '集成名称。', + 'type' => 'string', + 'example' => '云监控集成', + ], + 'IntegrationProductType' => [ + 'title' => '集成产品类型，CLOUD_MONITOR，LOG_SERVICE', + 'description' => '集成产品类型：'."\n" + ."\n" + .'- CLOUD_MONITOR：云监控'."\n" + .'- LOG_SERVICE：日志服务', + 'type' => 'string', + 'example' => 'CLOUD_MONITOR', + ], + 'ApiEndpoint' => [ + 'title' => '接口配置url', + 'description' => '集成地址。', + 'type' => 'string', + 'example' => 'https://alerts.aliyuncs.com/api/v1/integrations/custom/ymQBN******', + ], + 'ShortToken' => [ + 'title' => '接口配置token', + 'description' => '集成Token。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ymQBN******', + ], + 'State' => [ + 'title' => '是否启用，true/false', + 'description' => '告警集成是否启用：'."\n" + ."\n" + .'- true'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Liveness' => [ + 'title' => '就绪', + 'description' => '告警集成活跃度。'."\n" + ."\n", + 'type' => 'string', + 'example' => 'ready', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '告警集成创建时间。', + 'type' => 'string', + 'example' => '2022-06-18', + ], + 'IntegrationDetail' => [ + 'title' => '集成详情对象信息', + 'description' => '集成详情对象信息。', + 'type' => 'object', + 'properties' => [ + 'Description' => [ + 'title' => '集成描述', + 'description' => '告警集成描述信息。'."\n" + ."\n", + 'type' => 'string', + 'example' => '测试', + ], + 'DuplicateKey' => [ + 'title' => '去重得字段', + 'description' => '去重的字段。', + 'type' => 'string', + 'example' => 'LABEL.alertname::LABEL.severity', + ], + 'AutoRecover' => [ + 'title' => '是否设置恢复告警事件', + 'description' => '告警事件是否自动恢复：'."\n" + ."\n" + .'- true（默认）'."\n" + .'- false', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RecoverTime' => [ + 'title' => '恢复时间', + 'description' => '告警事件自动恢复时间，默认时间为300秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '300', + ], + 'Stat' => [ + 'description' => '最近1小时总数及异常数。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '最近1小时总数及异常数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[0,0]', + ], + ], + 'FieldRedefineRules' => [ + 'description' => '固定映射字段。'."\n" + ."\n", + 'type' => 'array', + 'items' => [ + 'description' => '事件映射，将源字段映射到目标字段。'."\n" + .'固定字段映射，创建集成时默认生成的固定映射。'."\n" + ."\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" + .']', + ], + ], + 'ExtendedFieldRedefineRules' => [ + 'description' => '拓展映射字段。', + 'type' => 'array', + 'items' => [ + 'description' => '事件映射，将源字段映射到目标字段，拓展字段增加映射。'."\n" + ."\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' => '告警事件恢复字段。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。'."\n" + .'> 仅日志服务支持设置此参数。', + 'type' => 'string', + 'example' => '$.status', + ], + 'InitiativeRecoverValue' => [ + 'description' => '告警事件恢复字段值。系统收到恢复事件后会根据恢复事件中的字段查询告警事件进行恢复。'."\n" + .'> 仅日志服务支持设置此参数。', + 'type' => 'string', + 'example' => 'ok', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看集成列表详情', + ], + 'CreateOrUpdateAlertRule' => [ + 'summary' => '创建或修改告警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '104428', + 'abilityTreeNodes' => [ + 'FEATUREarms20UGKV', + ], + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警规则ID', + 'description' => '告警规则ID。'."\n" + ."\n" + .'- 不填代表创建新的告警规则。'."\n" + .'- 填写代表修改指定告警规则信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '546xxx', + ], + ], + [ + 'name' => 'AlertName', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警规则名称', + 'description' => '告警规则名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Alert Rule Demo', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'title' => '地域', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlertType', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警规则类型', + 'description' => '告警规则类型：'."\n" + ."\n" + .'- APPLICATION\\_MONITORING\\_ALERT_RULE：应用监控告警规则。'."\n" + .'- BROWSER\\_MONITORING\\_ALERT_RULE：前端监控告警规则。'."\n" + .'- PROMETHEUS\\_MONITORING\\_ALERT_RULE：Prometheus监控告警规则。'."\n" + .'- XTRACE_MONITORING_ALERT_RULE：可观测链路OpenTelemetry版监控告警规则。'."\n" + .'- EBPF_MONITORING_ALERT_RULE：EBPF监控告警规则。'."\n" + .'- RUM_MONITORING_ALERT_RULE：用户体验监控告警规则。', + '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' => 'AlertStatus', + 'in' => 'formData', + 'schema' => [ + 'description' => '设置告警规则运行状态。'."\n" + ."\n" + .'- RUNNING（默认）：启动'."\n" + .'- STOPPED：停止'."\n", + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + ], + ], + [ + 'name' => 'NotifyStrategy', + 'in' => 'formData', + 'schema' => [ + 'description' => '指定通知策略。'."\n" + ."\n" + .'- null：不指定通知策略。当完成创建告警规则后，您可以通过新建通知策略并指定匹配规则和匹配条件（如告警规则名称等）来匹配该告警规则。当该告警规则被触发产生告警事件后，告警信息会被发送给通知策略中指定的联系人或联系人组。'."\n" + .'- 通知策略ID：指定某个通知策略。若选择此项，ARMS会自动在对应的通知策略添加一条匹配规则，匹配规则内容为告警规则ID（以告警规则名称的方式呈现），以确保当前告警规则产生的告警事件一定可以被选择的通知策略匹配到。', + 'type' => 'string', + 'required' => false, + 'example' => '569xxx', + ], + ], + [ + 'name' => 'Pids', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用监控或前端监控告警规则关联应用的PID。', + 'type' => 'string', + 'required' => false, + 'example' => '["b590lhguqs@40d8deedfa9******"]', + ], + ], + [ + 'name' => 'AutoAddNewApplication', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用监控或前端监控是否开启新创建应用追加到此告警规则功能。'."\n" + ."\n" + .'- `true`：开启'."\n" + .'- `false`：不开启', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'MetricsType', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用监控或前端监控告警规则的告警指标类型。详细信息请参见下方表格。', + 'type' => 'string', + 'required' => false, + 'example' => 'jvm', + ], + ], + [ + 'name' => 'Filters', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用监控或前端监控告警规则的筛选条件。'."\n" + .'格式如下：'."\n" + ."\n" + .'```'."\n" + .'"DimFilters": [ '."\n" + .'{ '."\n" + .' "FilterOpt": "ALL",'."\n" + .' "FilterValues": [], //过滤条件Value。'."\n" + .' "FilterKey": "rootIp" //过滤条件Key。'."\n" + .'}'."\n" + .']'."\n" + .'```'."\n" + .'**FilterOpt**取值如下：'."\n" + .'- STATIC： 固定匹配此维度值。'."\n" + .'- ALL：遍历所有维度值。注意：区间检测不支持遍历操作。'."\n" + .'- DISABLE：聚合所有维度值为一个值（求和）。', + 'type' => 'string', + 'required' => false, + 'example' => '{"DimFilters": [ { "FilterOpt": "ALL", "FilterValues": [], "FilterKey": "rootIp" } ] }', + ], + ], + [ + 'name' => 'AlertRuleContent', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用监控或前端监控的告警规则内容。**AlertRuleContent**模板如下，模板中各字段含义请参见表格下方的补充说明。'."\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" + .'> 不同的**MetricsType**，**AlertRuleItems.MetricKey**可使用的条件字段不同。应用监控和前端监控支持的指标类型以及各指标对应的告警规则字段，请参见表格下方的补充说明。', + '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" + .' }', + ], + ], + [ + 'name' => 'AlertCheckType', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus监控告警规则的告警检查类型。'."\n" + ."\n" + .'- STATIC： 静态阈值类型。 使用静态阈值时，必须指定**MetricsKey**参数，请参考表格下方关于Prometheus监控的**MetricsKey**参数说明填写。'."\n" + ."\n" + .'- CUSTOM：自定义PromQL类型。使用自定义PromQL时，必须指定**PromQL**、**Duration**和**Message**参数，用以创建Prometheus告警规则。', + 'type' => 'string', + 'required' => false, + 'example' => 'STATIC', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus监控告警规则的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', + ], + ], + [ + 'name' => 'AlertGroup', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的告警分组ID。'."\n" + ."\n" + .'- -1：自定义PromQL'."\n" + .'- 1：Kubernetes负载'."\n" + .'- 15：Kubernetes节点', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '-1', + ], + ], + [ + 'name' => 'PromQL', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的PromQL语句。', + 'type' => 'string', + 'required' => false, + 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', + ], + ], + [ + 'name' => 'Duration', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的持续时间，单位为分钟，取值范围[0,1440]。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'Level', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的等级。'."\n" + ."\n" + .'- P1：一般用于影响核心业务可用性，影响范围很大，可能导致严重后果的重大问题的告警通知。'."\n" + .'- P2：一般用于部分业务出错，会对系统可用性造成一定影响，但是影响范围相对有限的问题的告警通知。'."\n" + .'- P3：一般用于对可能导致业务出错或者受影响的问题的告警通知，或者在相对重要程度较低的业务发送的告警通知。'."\n" + .'- P4： 用于需要通知，但是优先级较低，也不会对业务造成影响的场景发送告警通知。'."\n" + .'- 默认：如果不需要区分告警等级，可以使用默认级别。', + 'type' => 'string', + 'required' => false, + 'example' => 'P2', + ], + ], + [ + 'name' => 'Message', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的告警内容。', + 'type' => 'string', + 'required' => false, + 'example' => '命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\"%.2f\\\\\\" $value }}%', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的标签。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Value": "cms_polardb", "Name": "_aliyun_cloud_product" } ]', + ], + ], + [ + 'name' => 'Annotations', + 'in' => 'formData', + 'schema' => [ + 'description' => 'Prometheus告警规则的注释。', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "Value": "PolarDB 慢查询数量", "Name": "_aliyun_display_name" }', + ], + ], + [ + 'name' => 'MetricsKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警指标。新建Prometheus告警规则时，如果**AlertCheckType**设置为**STATIC**，**MetricsKey**必填。'."\n" + ."\n" + .'> 不同的**AlertGroup**，对应的告警指标不同，**AlertGroup**和**MetricsKey**的对应关系请参见表格下方的补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'pop.status.error', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '告警规则标签（阿里云统一标签）。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'required' => false, + 'example' => 'owner', + ], + 'Value' => [ + 'description' => '标签的值(value)。', + 'type' => 'string', + 'required' => false, + 'example' => 'John', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'MarkTags', + 'in' => 'formData', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用标签。用于应用监控告警规则，筛选告警规则关联的应用。', + 'type' => 'array', + 'items' => [ + 'description' => '关联应用标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'service', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'proudct', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 100, + ], + ], + [ + 'name' => 'DataConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '数据配置。dataRevision字段指定指标无数据时的数据修复方式。'."\n" + ."\n" + .'- 补零 0'."\n" + .'- 补一 1 '."\n" + .'- 补null 2 （默认，不触发告警）', + 'type' => 'string', + 'required' => false, + 'example' => '{'."\n" + .' "dataRevision": 2'."\n" + .'}', + ], + ], + [ + 'name' => 'Notice', + 'in' => 'formData', + 'schema' => [ + 'description' => '生效时间及通知时间。用于兼容旧版规则。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'AlertPiplines', + 'in' => 'formData', + 'schema' => [ + 'description' => '报警发送通道配置。用于兼容旧版规则。', + 'type' => 'string', + 'required' => false, + 'example' => '-', + ], + ], + [ + 'name' => 'NotifyMode', + 'in' => 'formData', + 'schema' => [ + 'description' => '通知模式。普通模式或极简模式。'."\n" + .'- DIRECTED_MODE'."\n" + .'- NORMAL_MODE', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [], + 'example' => 'NORMAL_MODE', + 'default' => 'NORMAL_MODE', + 'enum' => [ + 'DIRECTED_MODE', + 'NORMAL_MODE', + ], + ], + ], + [ + 'name' => 'Product', + 'in' => 'formData', + 'schema' => [ + 'title' => '创建Prometheus告警规则时传入，后台会校验是否存在此产品，用于区分云产品过滤查询', + 'description' => '创建Prometheus告警规则时传入，后台会校验是否存在此产品，用于区分云产品过滤查询。', + 'type' => 'string', + 'required' => false, + 'example' => 'clickhouse', + ], + ], + [ + 'name' => 'AutoAddTargetConfig', + 'in' => 'formData', + 'schema' => [ + 'description' => '应用监控告警规则-告警应用自动追加配置。'."\n" + ."\n" + .'- autoAddMatchType：'."\n" + .' '."\n" + .' 匹配方式：正则匹配（REGULAR）/正则不匹配（NOT_REGULAR）'."\n" + ."\n" + .'- autoAddMatchExp：正则表达式', + 'type' => 'string', + 'required' => false, + 'example' => '{\\"autoAddMatchType\\":\\"REGULAR\\",\\"autoAddMatchExp\\":\\".*cbw.*\\"}', + ], + ], + [ + 'name' => 'CheckCycle', + 'in' => 'formData', + 'schema' => [ + 'description' => 'prometheus的告警检查周期。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'aliyunLang', + 'in' => 'formData', + 'schema' => [ + 'type' => 'string', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回数据结构体', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', + ], + 'AlertRule' => [ + 'description' => '告警规则对象。', + 'type' => 'object', + 'properties' => [ + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5510445', + ], + 'AlertName' => [ + 'title' => '告警规则名称', + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'arms-test', + ], + 'UserId' => [ + 'title' => '用户UID', + 'description' => '用户UID。', + 'type' => 'string', + 'example' => '1131971649******', + ], + 'RegionId' => [ + 'title' => '地域', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AlertType' => [ + 'title' => '告警规则类型', + 'description' => '告警规则类型：'."\n" + ."\n" + .'- APPLICATION\\_MONITORING\\_ALERT_RULE：应用监控告警规则。'."\n" + .'- BROWSER\\_MONITORING\\_ALERT_RULE：前端监控告警规则。'."\n" + .'- PROMETHEUS\\_MONITORING\\_ALERT_RULE：Prometheus监控告警规则。', + 'type' => 'string', + 'example' => 'APPLICATION_MONITORING_ALERT_RULE', + ], + 'AlertStatus' => [ + 'title' => '告警规则状态', + 'description' => '告警规则运行状态。'."\n" + ."\n" + .'- RUNNING：运行中'."\n" + .'- STOPPED：已停止'."\n" + .'- PAUSED：被暂停'."\n" + ."\n" + .'> PAUSED状态说明告警规则状态异常，被系统主动暂停，可能原因有告警规则唯独值过大或者关联集群已经被删除等。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'CreatedTime' => [ + 'title' => '创建时间', + 'description' => '告警规则创建时间的时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641438611000', + ], + 'UpdatedTime' => [ + 'title' => '更新时间', + 'description' => '告警规则更新时间的时间戳，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1641438611000', + ], + 'Extend' => [ + 'title' => '扩展字段', + 'description' => '扩展字段。', + 'type' => 'string', + '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' => [ + 'title' => '通知策略ID', + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => 'ALERT_MANAGER', + ], + 'Pids' => [ + 'title' => '应用监控/前端监控-告警关联应用ID', + 'description' => '应用监控或前端监控告警关联应用的PID。', + 'type' => 'array', + 'items' => [ + 'description' => '应用的PID。', + 'type' => 'string', + 'example' => 'b590lhguqs@40d8deedfa9******', + ], + ], + 'AutoAddNewApplication' => [ + 'title' => '应用监控/前端监控-是否开启新创建应用追加到此告警规则', + 'description' => '应用监控或前端监控是否开启新创建应用追加到此告警规则功能。'."\n" + ."\n" + .'- `true`：开启'."\n" + .'- `false`：不开启', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MetricsType' => [ + 'title' => '应用监控/前端监控-告警指标类型', + 'description' => '应用监控或前端监控告警规则的告警指标类型。', + 'type' => 'string', + 'example' => 'JVM', + ], + 'AlertRuleContent' => [ + 'title' => '应用监控/前端监控-告警规则内容', + 'description' => '应用监控或前端监控的告警规则内容。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '应用监控/前端监控-多个告警条件触发逻辑', + 'description' => '应用监控或前端监控多个告警条件之间的触发逻辑。'."\n" + ."\n" + .'- OR：满足下述任何一个条件。'."\n" + .'- AND：同时满足下述条件。', + 'type' => 'string', + 'example' => 'OR', + ], + 'AlertRuleItems' => [ + 'title' => '应用监控/前端监控-告警条件', + 'description' => '应用监控或前端监控告警规则的告警条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警条件对象。', + 'type' => 'object', + 'properties' => [ + 'N' => [ + 'title' => '应用监控/前端监控-最近N分钟', + 'description' => '最近N分钟。', + 'type' => 'number', + 'format' => 'float', + 'example' => '1', + ], + 'MetricKey' => [ + 'title' => '应用监控/前端监控-具体告警条件的指标', + 'description' => '具体告警条件的指标。', + 'type' => 'string', + 'example' => 'JVM非堆总使用内存量', + ], + 'Aggregate' => [ + 'title' => '应用监控/前端监控-聚合方式', + 'description' => '告警条件聚合方式。'."\n" + ."\n" + .'- AVG：平均'."\n" + .'- SUM：求和'."\n" + .'- MAX：最大值'."\n" + .'- MIN：最小值'."\n", + 'type' => 'string', + 'example' => 'AVG', + ], + 'Operator' => [ + 'title' => '应用监控/前端监控-判断条件', + 'description' => '告警条件的判断条件。'."\n" + ."\n" + .'- CURRENT_GTE：大于或等于'."\n" + .'- CURRENT_LTE：小于或等于'."\n" + .'- PREVIOUS_UP：环比上升百分比'."\n" + .'- PREVIOUS_DOWN：环比下降百分比'."\n" + .'- HOH_UP：与上小时同比上升百分比'."\n" + .'- HOH_DOWN：与上小时同比下降百分比'."\n" + .'- DOD_UP：与昨日同比上升百分比'."\n" + .'- DOD_DOWN：与昨日同比下降百分比', + 'type' => 'string', + 'example' => 'CURRENT_GTE', + ], + 'Value' => [ + 'title' => '应用监控/前端监控-阈值', + 'description' => '告警条件阈值。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'Filters' => [ + 'title' => '应用监控/前端监控-告警条件-过滤项', + 'description' => '应用监控或前端监控告警规则的过滤项。', + 'type' => 'object', + 'properties' => [ + 'DimFilters' => [ + 'description' => '应用监控或前端监控告警规则的过滤项信息。', + 'type' => 'array', + 'items' => [ + 'description' => '应用监控或前端监控告警规则的过滤条件对象。', + 'type' => 'object', + 'properties' => [ + 'FilterKey' => [ + 'description' => '过滤条件Key。', + 'type' => 'string', + 'example' => 'rootIp', + ], + 'FilterOpt' => [ + 'description' => '过滤条件操作关系。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'FilterValues' => [ + 'description' => '过滤条件参数信息。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤条件参数。', + 'type' => 'string', + 'example' => '[]', + ], + ], + ], + ], + ], + 'CustomSLSFilters' => [ + 'description' => '前端监控告警规则的自定义过滤条件。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义过滤条件对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '过滤条件Key。', + 'type' => 'string', + 'example' => 'username', + ], + 'Opt' => [ + 'description' => '过滤条件操作关系。'."\n" + ."\n" + .'- =：等于'."\n" + .'- not：不等于', + 'type' => 'string', + 'example' => '=', + ], + 'Value' => [ + 'description' => '过滤条件参数值。', + 'type' => 'string', + 'example' => 'test', + ], + 'T' => [ + 'description' => '仅用于区分前端监控日志类型，其它过滤条件不包含此字段。', + 'type' => 'string', + 'example' => 'null', + ], + 'Show' => [ + 'description' => '此筛选条件是否在前端展示。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'CustomSLSGroupByDimensions' => [ + 'description' => '聚合维度信息。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合维度参数值。', + 'type' => 'string', + 'example' => '["page"]', + ], + ], + 'CustomSLSWheres' => [ + 'description' => '设置的筛选条件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '设置的筛选条件参数值。', + 'type' => 'string', + 'example' => '["t like \'%api%\'"]', + ], + ], + ], + ], + 'AlertCheckType' => [ + 'title' => 'Prometheus告警-告警检查类型', + 'description' => 'Prometheus监控告警规则的告警检查类型。'."\n" + ."\n" + .'- STATIC： 静态阈值类型。'."\n" + ."\n" + .'- CUSTOM：自定义PromQL类型。', + 'type' => 'string', + 'example' => 'STATIC', + ], + 'ClusterId' => [ + 'title' => 'Prometheus告警-集群ID', + 'description' => 'Prometheus监控告警规则的集群ID。', + 'type' => 'string', + 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', + ], + 'AlertGroup' => [ + 'title' => 'Prometheus告警-告警分组ID', + 'description' => 'Prometheus告警规则的告警分组ID。'."\n" + ."\n" + .'- -1：自定义PromQL'."\n" + .'- 1：Kubernetes负载'."\n" + .'- 15：Kubernetes节点', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '-1', + ], + 'PromQL' => [ + 'title' => 'Prometheus告警-PromQL语句', + 'description' => 'Prometheus告警规则的PromQL语句。', + 'type' => 'string', + 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', + ], + 'Duration' => [ + 'title' => 'Prometheus告警-持续时间', + 'description' => 'Prometheus告警规则的持续时间，单位为分钟。', + 'type' => 'string', + 'example' => '1', + ], + 'Level' => [ + 'title' => 'Prometheus告警-等级', + 'description' => 'Prometheus告警规则的等级。'."\n" + ."\n" + .'- P1：一般用于影响核心业务可用性，影响范围很大，可能导致严重后果的重大问题的告警通知。'."\n" + .'- P2：一般用于部分业务出错，会对系统可用性造成一定影响，但是影响范围相对有限的问题的告警通知。'."\n" + .'- P3：一般用于对可能导致业务出错或者受影响的问题的告警通知，或者在相对重要程度较低的业务发送的告警通知。'."\n" + .'- P4： 用于需要通知，但是优先级较低，也不会对业务造成影响的场景发送告警通知。'."\n" + .'- 默认：如果不需要区分告警等级，可以使用默认级别。', + 'type' => 'string', + 'example' => 'P2', + ], + 'Message' => [ + 'title' => 'Prometheus告警-告警内容', + 'description' => 'Prometheus告警规则的告警内容。', + 'type' => 'string', + 'example' => '命名空间: {{$labels.namespace}} / Pod: {{$labels.pod_name}} / 容器: {{$labels.container}} 内存使用率超过80%, 当前值{{ printf \\\\\\"%.2f\\\\\\" $value }}%', + ], + 'Labels' => [ + 'title' => 'Prometheus告警-Label', + 'description' => 'Prometheus告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '键', + 'description' => '标签键。', + 'type' => 'string', + 'example' => '123', + ], + 'Value' => [ + 'title' => '值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + 'Annotations' => [ + 'title' => 'Prometheus告警-Annotation', + 'description' => 'Prometheus告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'description' => '注释结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '键', + 'description' => '注释键。', + 'type' => 'string', + 'example' => '123', + ], + 'Value' => [ + 'title' => '值', + 'description' => '注释值。', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + 'Tags' => [ + 'description' => '告警规则标签（阿里云统一标签）。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'owner', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'John', + ], + ], + ], + ], + 'NotifyMode' => [ + 'description' => '通知模式。', + 'type' => 'string', + 'example' => 'NORMAL_MODE', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建或修改告警规则', + 'requestParamsDescription' => '### **AlertRuleContent**模版字段说明'."\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：多个告警条件之间的触发逻辑。'."\n" + .' - OR：满足下述任何一个条件。'."\n" + .' - AND：同时满足下述条件。'."\n" + .'- Operator：告警条件的判断条件。'."\n" + .' - CURRENT_GTE：大于或等于'."\n" + .' - CURRENT_LTE：小于或等于'."\n" + .' - PREVIOUS_UP：环比上升百分比'."\n" + .' - PREVIOUS_DOWN：环比下降百分比'."\n" + .' - HOH_UP：与上小时同比上升百分比'."\n" + .' - HOH_DOWN：与上小时同比下降百分比'."\n" + .' - DOD_UP：与昨日同比上升百分比'."\n" + .' - DOD_DOWN：与昨日同比下降百分比'."\n" + .' - INTERVAL_EXCEED：区间检测。注意：区间检测不支持多条件触发。'."\n" + .'- MetricKey：具体告警条件的指标。不同的**MetricsType**，对应的指标不同。对应关系请参见下方说明。'."\n" + .'- Value：告警条件阈值。'."\n" + .'- Aggregate：告警条件聚合方式。'."\n" + .' - AVG：平均'."\n" + .' - SUM：求和'."\n" + .' - MAX：最大值'."\n" + .' - MIN：最小值'."\n" + .' - CONTINUOUS：持续'."\n" + .' - AVG_WEIGHTED：错误率加权平均值'."\n" + .'- N：最近N分钟。'."\n" + .'- Tolerability：表示区间容忍度，取值在1~200之间。'."\n" + ."\n" + .'### 应用监控**MetricsType**和**AlertRuleContent.AlertRuleItems.MetricKey**对应关系'."\n" + ."\n" + .'| MetricsType | 指标类型 | AlertRuleContent.AlertRuleItems.MetricKey |'."\n" + .'|---|---|---|'."\n" + .'| jvm | JVM监控 |- appstat.jvm.gc.oldgccountinstant：JVM FullGC次数（瞬时值）<br />- appstat.jvm.gc.oldgctimeinstant：JVM FullGC耗时（瞬时值）<br />- appstat.jvm.gc.younggccountinstant：JVM YoungGC次数（瞬时值）<br />- appstat.jvm.gc.younggctimeinstant：JVM YoungGC耗时（瞬时值）<br />- appstat.jvm.heap_total：JVM堆内总内存量<br />- appstat.jvm.heap_used：JVM堆内使用内存量<br />- appstat.jvm.non_heap_committed：JVM非堆内存提交值<br />- appstat.jvm.non_heap_init：JVM非堆内存初始值<br />- appstat.jvm.non_heap_max：JVM非堆内存最大值<br />- appstat.jvm.non_heap_used：JVM非堆总使用内存量<br />- appstat.jvm.threadblockedcount：JVM阻塞线程数<br />- appstat.jvm.threadcount：JVM线程总数<br />- appstat.jvm.threaddeadlockcount：JVM死锁线程数<br />- appstat.jvm.threadnewcount：JVM新建线程数<br />- appstat.jvm.threadrunnablecount：JVM可运行线程数<br />- appstat.jvm.threadterminatedcount：JVM终结线程数<br />- appstat.jvm.threadtimedwaitcount：JVM超时等待线程数<br />- appstat.jvm.threadwaitcount：JVM等待线程数<br /> |'."\n" + .'| saehost | SAE主机监控 |- appstat.infra.sae.systemcpu：CPU使用率<br />- appstat.infra.sae.systemdiskiopsread：磁盘IOPS读<br />- appstat.infra.sae.systemdiskiopswrite：磁盘IOPS写<br />- appstat.infra.sae.systemdiskrate：磁盘使用率<br />- appstat.infra.sae.systemdiskread：磁盘IO吞吐率读<br />- appstat.infra.sae.systemdisktotal：磁盘总量<br />- appstat.infra.sae.systemdiskused：磁盘使用量<br />- appstat.infra.sae.systemdiskwrite：磁盘IO吞吐率写<br />- appstat.infra.sae.systemload：系统负载<br />- appstat.infra.sae.systemmemrate：内存使用率<br />- appstat.infra.sae.systemmemtotal：总内存<br />- appstat.infra.sae.systemmemused：已用内存<br />- appstat.infra.sae.systemnetrecv：网络接收字节<br />- appstat.infra.sae.systemnetrecvdrop：网络接收数据丢包<br />- appstat.infra.sae.systemnetrecverror：网络接收错误数据包<br />- appstat.infra.sae.systemnetrecvpacket：网络接收数据包<br />- appstat.infra.sae.systemnettran：网络发送字节<br />- appstat.infra.sae.systemnettrandrop：网络发送数据丢包<br />- appstat.infra.sae.systemnettranerror：网络发送错误数据包<br />- appstat.infra.sae.systemnettranpacket：网络发送数据包|'."\n" + .'| txn_db | SQL指标 |- appstat.sql.count：数据库调用次数<br />- appstat.sql.error：数据库调用错误次数<br />- appstat.sql.rt：数据库调用响应时间|'."\n" + .'| db | 数据库指标 |- appstat.database.count：数据库调用次数<br />- appstat.database.errcount：数据库调用错误次数<br />- appstat.database.rt：数据库调用响应时间|'."\n" + .'| threadpool | 线程池监控 |- appstat.threadpool.threadcorepoolsize：核心线程数<br />- appstat.threadpool.threadmaxpoolsize：最大线程数<br />- appstat.threadpool.threadpoolactivecount：活跃线程数<br />- appstat.threadpool.threadpoolqueuesize：队列大小<br />- appstat.threadpool.threadpoolsize：当前线程数<br />- appstat.threadpool.threadpooltaskcount：已执行任务数<br />- appstat.threadpool.threadpoolusedpercent：线程池使用率|'."\n" + .'| exception | 异常接口调用 |- appstat.exception.count：应用异常接口调用次数<br />- appstat.exception.rt：应用异常接口调用响应时间|'."\n" + .'| txn_type | 应用依赖服务统计 |- appstat.outcall.count：应用依赖服务调用次数<br />- appstat.outcall.errorrate：应用依赖服务调用错误率<br />- appstat.outcall.rt：应用依赖服务调用响应时间|'."\n" + .'| txn | 应用提供服务统计 |- appstat.transaction.count：调用次数<br />- appstat.transaction.error：调用错误次数<br />- appstat.transaction.errorrate：调用错误率<br />- appstat.transaction.rt：调用响应时间|'."\n" + .'| host | 主机监控 |- appstat.jvm.systemcpuusage：节点机CPU使用率<br />- appstat.jvm.systemcpuuser：节点机CPU用户态占用率<br />- appstat.jvm.systemdiskfree：节点机空闲磁盘<br />- appstat.jvm.systemdiskusage：节点机磁盘利用率<br />- appstat.jvm.systemload：节点机系统负载<br />- appstat.jvm.systemmemfree：节点机空闲内存<br />- appstat.jvm.systemmemusage：节点机内存利用率<br />- appstat.jvm.systemnetinerrs：节点机接受错误报文数<br />- appstat.jvm.systemnetouterrs：节点机发送错误报文数|'."\n" + .'| scheduler | 定时任务 |- appstat.scheduler.rt：运行时间<br />- appstat.scheduler.count：运行次数<br />- appstat.scheduler.error：运行异常次数<br />- appstat.scheduler.delay：调度延迟时间<br />|'."\n" + ."\n" + .'### 前端监控**MetricsType**和**AlertRuleContent.AlertRuleItems.MetricKey**对应关系'."\n" + ."\n" + .'| MetricsType | 指标类型 | AlertRuleContent.AlertRuleItems.MetricKey |'."\n" + .'|---|---|---|'."\n" + .'| api | API指标 |- webstat.api.detail.count：API请求次数<br />- webstat.api.detail.fail_time：API失败耗时<br />- webstat.api.detail.fail_uv：报错API的影响用户数<br />- webstat.api.detail.success_rate：API成功率<br />- webstat.api.detail.success_time：API成功耗时|'."\n" + .'| page.api | 页面API指标 |- webstat.api.detail.page_api.count：API请求次数<br />- webstat.api.detail.page_api.fail_time：API失败耗时<br />- webstat.api.detail.page_api.success_rate：API成功率<br />- webstat.api.detail.page_api.success_time：API成功耗时|'."\n" + .'| page | 页面指标 |- webstat.api.detail.page_api.fail_uv：报错API的影响用户数<br />- webstat.index.pv：页面访问量<br />- webstat.jserror.count：JS错误数<br />- webstat.jserror.rate：JS错误率<br />- webstat.msg.top.error_uv：JS错误影响用户数<br />- webstat.resource.sum：资源错误数<br />- webstat.satisfy.satisfy：页面满意度<br />- webstat.speed.avg_cfpt：页面自定义首屏时间<br />- webstat.speed.avg_ctti：页面自定义可交互时间<br />- webstat.speed.avg_dns：页面DNS查询时间<br />- webstat.speed.avg_dom：页面dom解析时间<br />- webstat.speed.avg_fmp：页面首屏时间<br />- webstat.speed.avg_fpt：页面首次渲染耗时<br />- webstat.speed.avg_load：页面完全加载时间<br />- webstat.speed.avg_ready：ready时间<br />- webstat.speed.avg_res：页面资源加载时间<br />- webstat.speed.avg_ssl：页面SSL建连时间<br />- webstat.speed.avg_t1：页面自定义t1时间<br />- webstat.speed.avg_t10：页面自定义t10时间<br />- webstat.speed.avg_t2：页面自定义t2时间<br />- webstat.speed.avg_t3：页面自定义t3时间<br />- webstat.speed.avg_t4：页面自定义t4时间<br />- webstat.speed.avg_t5：页面自定义t5时间<br />- webstat.speed.avg_t6：页面自定义t6时间<br />- webstat.speed.avg_t7：页面自定义t7时间<br />- webstat.speed.avg_t8：页面自定义t8时间<br />- webstat.speed.avg_t9：页面自定义t9时间<br />- webstat.speed.avg_tcp：页面tcp连接时间<br />- webstat.speed.avg_trans：页面内容传输时间<br />- webstat.speed.avg_ttfb：页面网络请求响应时间<br />- webstat.speed.avg_tti：页面首次可交互时间|'."\n" + .'| custom | 自定义指标 |- webstat.avg.avg_val：自定义上报均值<br />- webstat.sum.sum_val：自定义上报求和|'."\n" + ."\n" + .'### Prometheus监控**AlertGroup**和**MetricsKey**对应关系'."\n" + ."\n" + .'| AlertGroup | 告警分组 | MetricsKey |'."\n" + .'|---|---|---|'."\n" + .'| 1 | Kubernetes负载 |- prom.workload.container_cpu_usage：容器CPU使用率<br />- prom.workload.job_execute_error：Job执行失败<br />- prom.workload.pod_cpu_usage：Pod磁盘使用率<br />- prom.workload.pod_start_timeout：Pod启动超时失败<br />- prom.workload.pod_restart_frequent：Pod频繁重启<br />- prom.workload.pod_status_error：Pod状态异常<br />- prom.workload.container_memory_usage：容器内存使用率<br />- prom.workload.deployment_pod_survival：Deployment Pod可用率|'."\n" + .'| 15 | Kubernetes节点 |- prom.node.node_memory_usage：节点内存使用率<br />- prom.node.node_cpu_usage：节点CPU使用率<br />- prom.node.node_disk_usage：节点磁盘使用率<br />- prom.node.node_status_error：节点状态异常|', + ], + 'DeleteAlertRule' => [ + 'summary' => '删除告警规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'title' => '告警规则ID', + 'description' => '告警规则ID。'."\n" + ."\n" + .'获取告警规则ID，请参见[GetAlertRules - 获取已经创建的告警规则](~~2612348~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'IsSuccess' => [ + 'description' => '是否成功删除告警规则。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除告警规则', + ], + 'ListAlertEvents' => [ + 'summary' => '查询告警事件历史。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AlertName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警名称', + 'description' => '告警名称。', + 'type' => 'string', + 'required' => false, + 'example' => '测试触发的告警', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', + 'description' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-19 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', + 'description' => '查询告警发送历史记录的结束时间，时间格式：YYYY-MM-DD HH:mm:ss', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-22 23:59:59', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示数目', + 'description' => '每页展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'MatchingConditions', + 'in' => 'query', + 'schema' => [ + 'title' => '事件匹配规则列表', + 'description' => '事件匹配规则列表。', + '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' => '事件状态。'."\n" + ."\n" + .'- Active：正在发生'."\n" + .'- Silenced：被静默'."\n" + .'- Resolved：已解决', + 'type' => 'string', + 'required' => false, + 'example' => 'Active', + ], + ], + [ + 'name' => 'ShowNotificationPolicies', + 'in' => 'query', + 'schema' => [ + 'description' => '是否展示关联的通知策略。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', + ], + 'PageBean' => [ + 'title' => '返回结构体', + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询到的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每页展示数目', + 'description' => '每页展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'Events' => [ + 'title' => '告警事件历史信息组', + 'description' => '告警事件历史信息组。', + 'type' => 'array', + 'items' => [ + 'description' => '告警事件列表。', + 'type' => 'object', + 'properties' => [ + 'AlertName' => [ + 'title' => '告警名称', + 'description' => '告警名称。', + 'type' => 'string', + 'example' => '测试触发的告警', + ], + 'Severity' => [ + 'title' => '告警等级(critical - p1 , error - p2, warning - p3, page - p4, default - p6)', + 'description' => '告警等级：'."\n" + ."\n" + .'- critical：p1'."\n" + .'- error：p2'."\n" + .'- warning：p3'."\n" + .'- page：p4'."\n" + .'- default：p6', + 'type' => 'string', + 'example' => 'critical', + ], + 'Status' => [ + 'title' => '告警状态(Active - 正在发生, Silenced - 被静默, Resolved - 已恢复 )', + 'description' => '事件状态。'."\n" + ."\n" + .'- Active：正在发生'."\n" + .'- Silenced：被静默'."\n" + .'- Resolved：已解决', + 'type' => 'string', + 'example' => 'Active', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '开始时间。', + 'type' => 'string', + 'example' => '2021-12-20 17:42:16', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '结束时间。', + 'type' => 'string', + 'example' => '2021-12-20 17:42:16', + ], + 'ReceiveTime' => [ + 'title' => '事件接受时间', + 'description' => '事件接收时间。', + 'type' => 'string', + 'example' => '2021-12-20 17:42:16', + ], + 'IntegrationName' => [ + 'title' => '集成名称', + 'description' => '集成名称。', + 'type' => 'string', + 'example' => '自定义集成', + ], + 'IntegrationType' => [ + 'title' => '集成类型', + 'description' => '集成类型。', + 'type' => 'string', + 'example' => 'CUSTOM', + ], + 'GeneratorURL' => [ + 'title' => '事件地址', + 'description' => '事件地址。', + 'type' => 'string', + 'example' => 'https://xxx.xx/', + ], + 'Description' => [ + 'title' => '事件描述', + 'description' => '事件描述。', + 'type' => 'string', + 'example' => '测试', + ], + 'Annotations' => [ + 'title' => '注释列表', + 'description' => '注释列表。', + 'type' => 'string', + 'example' => '[{\\"Name\\":\\"annotation-a\\",\\"Value\\":\\"annotation a value\\"}]', + ], + 'Labels' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'string', + 'example' => '[{\\"name\\":\\"severity\\",\\"value\\":\\"error\\"}]', + ], + 'Alarms' => [ + 'title' => '关联告警', + 'description' => '关联告警。', + 'type' => 'array', + 'items' => [ + 'description' => '告警信息。', + 'type' => 'object', + 'properties' => [ + 'AlarmId' => [ + 'title' => '告警ID', + 'description' => '告警ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '77444', + ], + 'AlarmName' => [ + 'title' => '告警名称', + 'description' => '告警名称。', + 'type' => 'string', + 'example' => '测试触发的告警', + ], + 'State' => [ + 'title' => '告警状态(0-待处理，1-处理中，2-已解决）', + 'description' => '告警状态：'."\n" + ."\n" + .'- 0：待处理'."\n" + .'- 1：处理中'."\n" + .'- 2：已解决', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'CreateTime' => [ + 'title' => '告警创建时间', + 'description' => '告警创建时间。', + 'type' => 'string', + 'example' => '2021-12-20 07:10:18', + ], + ], + ], + ], + 'HandlerName' => [ + 'description' => '处理人。', + 'type' => 'string', + 'example' => '张三', + ], + 'NotificationPolicies' => [ + 'description' => '关联的通知策略。', + 'type' => 'array', + 'items' => [ + 'description' => '通知策略。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '646093', + ], + 'Name' => [ + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => 'P1告警通知策略', + ], + ], + ], + ], + 'TriggerCount' => [ + 'description' => '触发次数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询告警事件历史', + ], + 'GetAlertRules' => [ + 'summary' => '查询已经创建的告警规则。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + 'abilityTreeCode' => '109306', + 'abilityTreeNodes' => [ + 'FEATUREarms20UGKV', + ], + ], + 'parameters' => [ + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => [ + 'title' => '告警规则ID', + 'description' => '告警规则ID列表，告警规则ID是识别告警规则的唯一标志，不会重复。'."\n" + ."\n" + .'- 如果不指定，API请求将不会根据告警规则ID对告警规则进行筛选。'."\n" + .'- 如果指定了告警规则ID列表，那么此次请求将只会返回在列表中的告警规则的子集，其它筛选条件也会同时生效。'."\n" + ."\n" + .'> 您可以通过其他请求参数调用GetAlertRules接口，从返回信息中获取AlertIds，后续您可以直接通过AlertIds查询指定的告警规则。', + 'type' => 'string', + 'required' => false, + 'example' => '["12345"]', + ], + ], + [ + 'name' => 'AlertNames', + 'in' => 'query', + 'schema' => [ + 'title' => '告警规则名称', + 'description' => '告警规则名称列表。新版告警规则创建时不允许出现重名，但是存量告警规则可能存在重名告警，因此**AlertName**不是告警规则的唯一标志。'."\n" + ."\n" + .'- 如果不指定，将不会对告警规则进行过滤。'."\n" + .'- 如果指定告警规则名称列表，本次请求将只返回在列表中的告警的子集，其它的筛选条件也会生效。', + 'type' => 'string', + 'required' => false, + 'example' => '["test"]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'title' => '地域', + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlertType', + 'in' => 'query', + 'schema' => [ + 'title' => '告警规则类型（必填）', + 'description' => '告警规则类型。'."\n" + .'新版告警必传。'."\n" + ."\n" + .'- APPLICATION_MONITORING_ALERT_RULE：应用监控告警规则。'."\n" + .'- BROWSER_MONITORING_ALERT_RULE：前端监控告警规则。'."\n" + .'- PROMETHEUS_MONITORING_ALERT_RULE：Prometheus监控告警规则。', + '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', + ], + ], + ], + [ + 'name' => 'AlertStatus', + 'in' => 'query', + 'schema' => [ + 'title' => '告警规则运行状态', + 'description' => '告警规则运行状态。'."\n" + ."\n" + .'- RUNNING：运行中'."\n" + .'- STOPPED：已停止'."\n" + .'- PAUSED：被暂停'."\n" + ."\n\n" + .'> PAUSED状态说明告警规则状态异常，被系统主动暂停，可能原因有告警规则唯独值过大或者关联集群已经被删除等。', + 'type' => 'string', + 'required' => false, + 'example' => 'RUNNING', + 'enum' => [ + 'STOPPED', + 'RUNNING', + 'PAUSED', + ], + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus监控告警规则的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'ceba9b9ea5b924dd0b6726d2de6******'."\n", + ], + ], + [ + 'name' => 'ProductCode', + 'in' => 'query', + 'schema' => [ + 'description' => '无需填写。', + 'type' => 'string', + 'required' => false, + 'example' => 'null', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询第N页告警。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '每一页大小', + 'description' => '每一页告警规则数量。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 1, + ], + ], + [ + 'name' => 'BizRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '规则所在的区域ID', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '337B8F7E-0A64-5768-9225-E9B3CF******', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的告警规则总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每一页大小', + 'description' => '每一页告警规则数量。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'AlertRules' => [ + 'title' => '告警规则列表', + 'description' => '告警规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则列表结构体。', + 'type' => 'object', + 'properties' => [ + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5730***', + ], + 'AlertName' => [ + 'title' => '告警规则名称', + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'arms-test', + ], + 'UserId' => [ + 'title' => '用户UID', + 'description' => '阿里云账号ID。', + 'type' => 'string', + 'example' => '1131971649******', + ], + 'RegionId' => [ + 'title' => '地域', + 'description' => '地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AlertType' => [ + 'title' => '告警规则类型', + 'description' => '告警规则类型。'."\n" + .'- APPLICATION_ MONITORING_ ALERT_RULE：应用监控告警规则。'."\n" + .'- BROWSER_ MONITORING_ ALERT_RULE：前端监控告警规则。'."\n" + .'- PROMETHEUS_ MONITORING_ ALERT_RULE：Prometheus监控告警规则。', + 'type' => 'string', + 'example' => 'APPLICATION_MONITORING_ALERT_RULE', + ], + 'AlertStatus' => [ + 'title' => '告警规则状态', + 'description' => '告警规则运行状态。'."\n" + ."\n" + .'- RUNNING：运行中'."\n" + .'- STOPPED：已停止'."\n" + .'- PAUSED：被暂停'."\n" + ."\n" + .'> PAUSED状态说明告警规则状态异常，被系统主动暂停，可能原因有告警规则唯独值过大或者关联集群已经被删除等。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'CreatedTime' => [ + 'title' => '创建时间', + 'description' => '告警规则创建时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640333981000', + ], + 'UpdatedTime' => [ + 'title' => '更新时间', + 'description' => '告警规则更新时间的时间戳，单位为毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1640333981000', + ], + 'Extend' => [ + 'title' => '扩展字段', + 'description' => '扩展字段。'."\n" + ."\n" + .'> 如果是存量应用监控告警规则，字段会包含联系人、告警模板、通知内容等信息。', + 'type' => 'string', + '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' => [ + 'title' => '通知策略ID', + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => 'ALERT_MANAGER', + ], + 'Pids' => [ + 'title' => '应用监控/前端监控-告警关联应用ID', + 'description' => '应用监控或前端监控告警关联应用的PID。', + 'type' => 'array', + 'items' => [ + 'description' => '应用的PID。', + 'type' => 'string', + 'example' => '["b590lhguqs@40d8deedfa9******"]', + ], + ], + 'AutoAddNewApplication' => [ + 'title' => '应用监控/前端监控-是否开启新创建应用追加到此告警规则', + 'description' => '应用监控或前端监控是否开启新创建应用追加到此告警规则功能。'."\n" + ."\n" + .'- `true`：开启'."\n" + .'- `false`：不开启', + 'type' => 'boolean', + 'example' => 'false', + ], + 'MetricsType' => [ + 'title' => '应用监控/前端监控-告警指标类型', + 'description' => '应用监控或前端监控告警规则的告警指标类型。', + 'type' => 'string', + 'example' => 'JVM', + ], + 'AlertRuleContent' => [ + 'title' => '应用监控/前端监控-告警规则内容', + 'description' => '应用监控或前端监控的告警规则内容。', + 'type' => 'object', + 'properties' => [ + 'Condition' => [ + 'title' => '应用监控/前端监控-多个告警条件触发逻辑', + 'description' => '应用监控或前端监控多个告警条件之间的触发逻辑。'."\n" + ."\n" + .'- OR：满足下述任何一个条件。'."\n" + .'- AND：同时满足下述条件。', + 'type' => 'string', + 'example' => 'OR', + ], + 'AlertRuleItems' => [ + 'title' => '应用监控/前端监控-告警条件', + 'description' => '应用监控或前端监控告警规则的告警条件。', + 'type' => 'array', + 'items' => [ + 'description' => '告警条件对象。', + 'type' => 'object', + 'properties' => [ + 'N' => [ + 'description' => '最近N分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'MetricKey' => [ + 'title' => '应用监控/前端监控-具体告警条件的指标', + 'description' => '具体告警条件的指标。', + 'type' => 'string', + 'example' => 'appstat.jvm.non_heap_used', + ], + 'Aggregate' => [ + 'title' => '应用监控/前端监控-聚合方式', + 'description' => '告警条件聚合方式。'."\n" + ."\n" + .'- AVG：平均'."\n" + .'- SUM：求和'."\n" + .'- MAX：最大值'."\n" + .'- MIN：最小值'."\n", + 'type' => 'string', + 'example' => 'AVG', + ], + 'Operator' => [ + 'title' => '应用监控/前端监控-判断条件', + 'description' => '告警条件的判断条件。'."\n" + ."\n" + .'- CURRENT_GTE：大于或等于'."\n" + .'- CURRENT_LTE：小于或等于'."\n" + .'- PREVIOUS_UP：环比上升百分比'."\n" + .'- PREVIOUS_DOWN：环比下降百分比'."\n" + .'- HOH_UP：与上小时同比上升百分比'."\n" + .'- HOH_DOWN：与上小时同比下降百分比'."\n" + .'- DOD_UP：与昨日同比上升百分比'."\n" + .'- DOD_DOWN：与昨日同比下降百分比', + 'type' => 'string', + 'example' => 'CURRENT_GTE', + ], + 'Value' => [ + 'title' => '应用监控/前端监控-阈值', + 'description' => '告警条件阈值。', + 'type' => 'string', + 'example' => '1', + ], + ], + ], + ], + ], + ], + 'Filters' => [ + 'title' => '应用监控/前端监控-告警条件-过滤项', + 'description' => '应用监控或前端监控告警规则的过滤项。', + 'type' => 'object', + 'properties' => [ + 'DimFilters' => [ + 'description' => '应用监控或前端监控告警规则的过滤项信息。', + 'type' => 'array', + 'items' => [ + 'description' => '应用监控或前端监控告警规则的过滤条件对象。', + 'type' => 'object', + 'properties' => [ + 'FilterKey' => [ + 'description' => '过滤条件Key。', + 'type' => 'string', + 'example' => 'rootIp', + ], + 'FilterOpt' => [ + 'description' => '过滤条件操作关系。', + 'type' => 'string', + 'example' => 'ALL', + ], + 'FilterValues' => [ + 'description' => '过滤条件参数信息。', + 'type' => 'array', + 'items' => [ + 'description' => '过滤条件参数。', + 'type' => 'string', + 'example' => 'null', + ], + ], + ], + ], + ], + 'CustomSLSFilters' => [ + 'description' => '前端监控告警规则的自定义过滤条件。', + 'type' => 'array', + 'items' => [ + 'description' => '自定义过滤条件对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '过滤条件Key。', + 'type' => 'string', + 'example' => 'username', + ], + 'Opt' => [ + 'description' => '过滤条件操作关系。'."\n" + ."\n" + .'- =：等于'."\n" + .'- not：不等于', + 'type' => 'string', + 'example' => '=', + ], + 'Value' => [ + 'description' => '过滤条件参数值。', + 'type' => 'string', + 'example' => 'test', + ], + 'T' => [ + 'description' => '仅用于区分前端监控日志类型，其它过滤条件不包含此字段。', + 'type' => 'string', + 'example' => 'null', + ], + 'Show' => [ + 'description' => '此筛选条件是否在前端展示。', + 'type' => 'boolean', + 'example' => 'false', + ], + ], + ], + ], + 'CustomSLSGroupByDimensions' => [ + 'description' => '聚合维度信息。', + 'type' => 'array', + 'items' => [ + 'description' => '聚合维度参数值。', + 'type' => 'string', + 'example' => '["page"]', + ], + ], + 'CustomSLSWheres' => [ + 'description' => '设置筛选条件信息。', + 'type' => 'array', + 'items' => [ + 'description' => '设置筛选条件参数值。', + 'type' => 'string', + 'example' => '["t like \'%api%\'"]', + ], + ], + ], + ], + 'AlertCheckType' => [ + 'title' => 'Prometheus告警-告警检查类型', + 'description' => 'Prometheus监控告警规则的告警检查类型。'."\n" + ."\n" + .'- STATIC： 静态阈值类型。 '."\n" + .'- CUSTOM：自定义PromQL类型。', + 'type' => 'string', + 'example' => 'STATIC', + ], + 'ClusterId' => [ + 'title' => 'Prometheus告警-集群ID', + 'description' => 'Prometheus监控告警规则的集群ID。', + 'type' => 'string', + 'example' => 'ceba9b9ea5b924dd0b6726d2de6******', + ], + 'AlertGroup' => [ + 'title' => 'Prometheus告警-告警分组ID', + 'description' => 'Prometheus告警规则的告警分组ID。'."\n" + ."\n" + .'- -1：自定义PromQL'."\n" + .'- 1：Kubernetes负载'."\n" + .'- 15：Kubernetes节点', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'PromQL' => [ + 'title' => 'Prometheus告警-PromQL语句', + 'description' => 'Prometheus告警规则的PromQL语句。', + 'type' => 'string', + 'example' => 'node_memory_MemAvailable_bytes{} / node_memory_MemTotal_bytes{} * 100', + ], + 'Duration' => [ + 'title' => 'Prometheus告警-持续时间', + 'description' => 'Prometheus告警规则的持续时间。', + 'type' => 'string', + 'example' => '1', + ], + 'Level' => [ + 'title' => 'Prometheus告警-等级', + 'description' => 'Prometheus告警规则的等级。'."\n" + ."\n" + .'- P1：一般用于影响核心业务可用性，影响范围很大，可能导致严重后果的重大问题的告警通知。'."\n" + .'- P2：一般用于部分业务出错，会对系统可用性造成一定影响，但是影响范围相对有限的问题的告警通知。'."\n" + .'- P3：一般用于对可能导致业务出错或者受影响的问题的告警通知，或者在相对重要程度较低的业务发送的告警通知。'."\n" + .'- P4： 用于需要通知，但是优先级较低，也不会对业务造成影响的场景发送告警通知。'."\n" + .'- 默认：如果不需要区分告警等级，可以使用默认级别。', + 'type' => 'string', + 'example' => 'P2', + ], + 'Message' => [ + 'title' => 'Prometheus告警-告警内容', + 'description' => 'Prometheus告警规则的告警内容。', + 'type' => 'string', + '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' => 'Prometheus告警-Label', + 'description' => 'Prometheus告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '键', + 'description' => '标签键。', + 'type' => 'string', + 'example' => '123', + ], + 'Value' => [ + 'title' => '值', + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + 'Annotations' => [ + 'title' => 'Prometheus告警-Annotation', + 'description' => 'Prometheus告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'description' => '注释结构体。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'title' => '键', + 'description' => '注释键。', + 'type' => 'string', + 'example' => '123', + ], + 'Value' => [ + 'title' => '值', + 'description' => '注释值。', + 'type' => 'string', + 'example' => 'abc', + ], + ], + ], + ], + 'Tags' => [ + 'description' => '告警规则标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'example' => 'prod', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取已经创建的告警规则', + 'extraInfo' => '### 更多示例'."\n" + .'### 获取杭州地域的前端监控告警规则'."\n" + .'**请求示例：**'."\n" + .'```'."\n" + .'http(s)://[Endpoint]/?Action=GetAlertRules'."\n" + .'&AlertIds=["12345"]'."\n" + .'&AlertNames=["前端监控默认报警"]'."\n" + .'&RegionId=cn-hangzhou'."\n" + .'&AlertType=BROWSER_MONITORING_ALERT_RULE'."\n" + .'&AlertStatus=STOPPED'."\n" + .'&Page=1'."\n" + .'&Size=20'."\n" + .'&公共请求参数'."\n" + .'```'."\n" + .'**返回示例：**'."\n" + .'```'."\n" + .'{'."\n" + .' "PageBean": {'."\n" + .' "AlertRules": ['."\n" + .' {'."\n" + .' "AlertId": 12345,'."\n" + .' "AlertName": "前端监控默认报警",'."\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\\\\\\":\\\\\\"报警名称:$报警名称\\\\\\\\\\\\\\\\n筛选条件: $筛选\\\\\\\\\\\\\\\\n报警时间: $报警时间\\\\\\\\\\\\\\\\n报警内容: $报警内容\\\\\\\\\\\\\\\\n注意！：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！\\\\\\",\\\\\\"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" + .'### 获取杭州地域的Prometheus监控告警规则'."\n" + .'**请求示例：**'."\n" + .'```'."\n" + .'http(s)://[Endpoint]/?Action=GetAlertRules'."\n" + .'&AlertIds=["12345"]'."\n" + .'&AlertNames=["ES节点磁盘使用率大于85%"]'."\n" + .'&RegionId=cn-hangzhou'."\n" + .'&AlertType=PROMETHEUS_MONITORING_ALERT_RULE'."\n" + .'&AlertStatus=RUNNING'."\n" + .'&Page=1'."\n" + .'&Size=20'."\n" + .'&公共请求参数'."\n" + .'```'."\n" + .'**返回示例：**'."\n" + .'```'."\n" + .'{'."\n" + .' "PageBean": {'."\n" + .' "AlertRules": ['."\n" + .' {'."\n" + .' "AlertName": "ES节点磁盘使用率大于85%",'."\n" + .' "CreatedTime": 1643188668035,'."\n" + .' "Message": "集群ID: {{$labels.cluster_id}} 节点IP: {{$labels.node_id}} 磁盘使用率 告警当时值{{ printf \\"%.2f\\" $value }}%\\n详情见 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节点磁盘使用率",'."\n" + .' "Name": "_aliyun_display_name"'."\n" + .' },'."\n" + .' {'."\n" + .' "Value": "集群ID: {{$labels.cluster_id}} 节点IP: {{$labels.node_id}} 磁盘使用率 告警当时值{{ printf \\"%.2f\\" $value }}%\\n详情见 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" + ."\n" + .'```', + ], + 'CreateOrUpdateContact' => [ + 'summary' => '创建或者修改告警联系人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人ID', + 'description' => '告警联系人ID。'."\n" + ."\n" + .'- 不填代表创建新的告警联系人。'."\n" + .'- 填写代表修改指定告警联系人信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人名称', + 'description' => '告警联系人姓名。', + 'type' => 'string', + 'required' => true, + 'example' => 'JohnDoe', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人手机号码', + 'description' => '告警联系人手机号码。'."\n" + ."\n" + .'> **Phone**和**Email**参数至少填写一项。每个手机号码或邮箱只能用于一个联系人。', + 'type' => 'string', + 'required' => false, + 'example' => '1381111****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人邮箱', + 'description' => '告警联系人邮箱地址。'."\n" + .'> **Phone**和**Email**参数至少填写一项。每个手机号码或邮箱只能用于一个联系人。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'ReissueSendNotice', + 'in' => 'formData', + 'schema' => [ + 'title' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', + 'description' => '电话通知失败后，通知补发类型。'."\n" + ."\n" + .'- 0：不补发'."\n" + .'- 1：重复拨打一次电话'."\n" + .'- 2：发送短信通知'."\n" + .'- 3（默认）：使用全局默认值', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '3', + ], + ], + [ + 'name' => 'IsEmailVerify', + 'in' => 'formData', + 'schema' => [ + 'description' => '邮箱是否已验证', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DingRobotUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '钉钉Webhook地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=69d4e0******', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'CorpUserId', + 'in' => 'formData', + 'schema' => [ + 'description' => '告警联系人在自己企业组织内的标识，用于三方IM的@功能', + 'type' => 'string', + 'required' => false, + 'example' => 'A123221', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', + ], + 'AlertContact' => [ + 'description' => '返回AlertContact对象。', + 'type' => 'object', + 'properties' => [ + 'ContactId' => [ + 'title' => '告警联系人ID', + 'description' => '告警联系人ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'ContactName' => [ + 'title' => '告警联系人名称', + 'description' => '告警联系人姓名。', + 'type' => 'string', + 'example' => 'JohnDoe', + ], + 'Phone' => [ + 'title' => '告警联系人手机号', + 'description' => '告警联系人手机号码。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Email' => [ + 'title' => '告警联系人邮箱', + 'description' => '告警联系人邮箱地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'IsVerify' => [ + 'title' => '手机号码验证标识', + 'description' => '手机号码验证标识。'."\n" + ."\n" + .'- `false`（默认）：未验证。'."\n" + .'- `true`：已验证。'."\n" + ."\n" + .'您可以通过调用**SendTTSVerifyLink**接口验证联系人手机号，仅验证过的手机号可以在通知策略中使用电话的通知方式。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ReissueSendNotice' => [ + 'title' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', + 'description' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'isEmailVerify' => [ + 'description' => '邮箱是否已验证。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DingRobotUrl' => [ + 'description' => '钉钉告警机器人URL。', + 'type' => 'string', + 'example' => 'https://test1.com', + ], + ], + ], + ], + ], + ], + ], + 'responseDemo' => '[{"type":"json","example":"{\\n \\"RequestId\\": \\"E9C9DA3D-10FE-472E-9EEF-2D0A3E41****\\",\\n \\"AlertContact\\": {\\n \\"ContactId\\": 123,\\n \\"ContactName\\": \\"JohnDoe\\",\\n \\"Phone\\": \\"1381111****\\",\\n \\"Email\\": \\"[email protected]\\",\\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>[email protected]</Email>\\n <IsVerify>false</IsVerify>\\n </AlertContact>\\n</CreateOrUpdateContactResponse>","errorExample":""}]', + 'title' => '创建或修改联系人', + ], + 'SendTTSVerifyLink' => [ + 'summary' => '为告警联系人发送手机号码验证短信。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人ID', + 'description' => '告警联系人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人手机号码', + 'description' => '告警联系人手机号码。', + 'type' => 'string', + 'required' => true, + 'example' => '1381111****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'IsSuccess' => [ + 'description' => '是否成功发送手机号码验证短信。'."\n" + ."\n" + .'- `true`：发送成功'."\n" + ."\n" + .'- `false`：发送失败', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '告警联系人发送手机号码验证', + 'description' => '收到手机号码验证短信后，请根据短信提示完成手机号验证。仅验证过的手机号可以在通知策略中使用电话的通知方式。', + ], + 'DeleteContact' => [ + 'summary' => '删除告警联系人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'title' => '告警联系人ID', + 'description' => '告警联系人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'IsSuccess' => [ + 'description' => '是否成功删除告警联系人。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + ."\n" + .'- `false`：删除失败。', + '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' => '删除告警联系人', + ], + 'DescribeContacts' => [ + 'summary' => '查询告警联系人列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '118543', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警联系人名称', + 'description' => '告警联系人姓名。', + 'type' => 'string', + 'required' => false, + 'example' => 'John Doe', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'title' => '告警联系人手机号码', + 'description' => '告警联系人手机号码。', + 'type' => 'string', + 'required' => false, + 'example' => '1381111*****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'title' => '告警联系人邮箱', + 'description' => '告警联系人邮箱地址。', + 'type' => 'string', + 'required' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页展示的联系人数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => [ + 'description' => '需要查询的联系人id。多个联系人id以空格分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '123,321', + ], + ], + [ + 'name' => 'Verbose', + 'in' => 'query', + 'schema' => [ + 'description' => '返回冗余信息开关', + 'type' => 'string', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的联系人总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每一页大小', + 'description' => '每页的联系人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'AlertContacts' => [ + 'title' => '告警联系人列表', + 'description' => '告警联系人列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => [ + 'title' => '告警联系人ID', + 'description' => '告警联系人ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'ContactName' => [ + 'title' => '告警联系人名称', + 'description' => '告警联系人姓名。', + 'type' => 'string', + 'example' => 'John Doe', + ], + 'Phone' => [ + 'title' => '告警联系人手机号码', + 'description' => '告警联系人手机号码。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Email' => [ + 'title' => '告警联系人邮箱', + 'description' => '告警联系人邮箱地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'IsVerify' => [ + 'title' => '手机号码是否验证标识', + 'description' => '手机号码是否验证标识。'."\n" + ."\n" + .'- `false`：未验证。'."\n" + .'- `true`：已验证。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ReissueSendNotice' => [ + 'title' => '电话通知失败补发类型：0. 不补发 1. 重复拨打一次电话 2. 发送短信通知 3. 使用全局默认值（当前为不补发）', + 'description' => '电话通知失败后，通知补发类型。'."\n" + ."\n" + .'- 0：不补发'."\n" + .'- 1：重复拨打一次电话'."\n" + .'- 2：发送短信通知'."\n" + .'- 3（默认）：使用全局默认值', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3', + ], + 'IsEmailVerify' => [ + 'description' => '邮箱是否已验证', + 'type' => 'boolean', + 'example' => 'true', + ], + 'ArmsContactId' => [ + 'description' => '告警联系人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100147', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\",\\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>[email protected]</Email>\\n <IsVerify>false</IsVerify>\\n </AlertContacts>\\n </PageBean>\\n</DescribeContactsResponse>","errorExample":""}]', + 'title' => '查询告警联系人列表', + ], + 'CreateOrUpdateContactGroup' => [ + 'summary' => '创建或修改告警联系人组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupId', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人组ID', + 'description' => '告警联系人组ID。'."\n" + ."\n" + .'- 不填代表创建新的联系人组。'."\n" + .'- 填写代表修改指定告警联系人组信息。'."\n", + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ContactGroupName', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人组名称', + 'description' => '告警联系人组名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'ContactIds', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警联系人ids', + 'description' => '需要添加至该联系人组的联系人ID。多个联系人ID之间通过半角逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '[1,2,3]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', + ], + 'AlertContactGroup' => [ + 'description' => '返回AlertContactGroup对象。', + 'type' => 'object', + 'properties' => [ + 'ContactGroupId' => [ + 'title' => '告警联系人组ID', + 'description' => '告警联系人组ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'ContactGroupName' => [ + 'title' => '告警联系人组名称', + 'description' => '告警联系人组名称。', + 'type' => 'string', + 'example' => 'TestGroup', + ], + 'ContactIds' => [ + 'title' => '告警联系人ids', + 'description' => '告警联系人组包含的联系人ID。', + 'type' => 'string', + 'example' => '[1,2,3]', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建或修改告警联系人组', + ], + 'DeleteContactGroup' => [ + 'summary' => '删除告警联系人组。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupId', + 'in' => 'query', + 'schema' => [ + 'title' => '告警联系人组ID', + 'description' => '告警联系人组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'IsSuccess' => [ + 'description' => '是否成功删除告警联系人组。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + ."\n" + .'- `false`：删除失败。', + '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' => '删除告警联系人组', + ], + 'DescribeContactGroups' => [ + 'summary' => '查询告警联系人分组信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '118624', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警联系人组名称', + 'description' => '告警联系人组名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页展示的联系人组数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => [ + 'title' => '是否返回联系人分组中包含的所有联系人。默认不返回所有联系人。', + 'description' => '返回的联系人分组信息中是否包含所有联系人。'."\n" + ."\n" + .'- `fasle`（默认）：不返回所有联系人。'."\n" + .'- `true`：返回所有联系人。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人组ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的联系人组总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每一页数目', + 'description' => '每页的联系人组数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'AlertContactGroups' => [ + 'title' => '告警联系人组列表', + 'description' => '告警联系人组列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactGroupId' => [ + 'title' => '告警联系人组ID', + 'description' => '告警联系人组ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'ContactGroupName' => [ + 'title' => '告警联系人组名称', + 'description' => '告警联系人组名称。', + 'type' => 'string', + 'example' => 'TestGroup', + ], + 'Contacts' => [ + 'title' => '联系人对象', + 'description' => '联系人信息。**IsDetail**设置为`false`时不显示**Contacts**。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => [ + 'title' => '联系人ID', + 'description' => '联系人ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '456', + ], + 'ContactName' => [ + 'title' => '联系人名称', + 'description' => '联系人姓名。', + 'type' => 'string', + 'example' => 'John Doe', + ], + 'Phone' => [ + 'title' => '联系人手机号码', + 'description' => '联系人手机号码。', + 'type' => 'string', + 'example' => '1381111****', + ], + 'Email' => [ + 'title' => '联系人邮箱', + 'description' => '联系人邮箱地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ArmsContactId' => [ + 'description' => '告警联系人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '100117', + ], + ], + ], + ], + 'ArmsContactGroupId' => [ + 'description' => '告警联系人组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '83261', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\",\\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>[email protected]</Email>\\n </Contacts>\\n </AlertContactGroups>\\n </PageBean>\\n</DescribeContactGroupsResponse>","errorExample":""}]', + 'title' => '查询告警联系人分组信息', + ], + 'CreateOrUpdateIMRobot' => [ + 'summary' => '创建或更新IM机器人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '118628', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RobotId', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警机器人ID', + 'description' => 'IM机器人ID。'."\n" + ."\n" + .'- 不填代表创建新的IM机器人。'."\n" + .'- 填写代表修改指定IM机器人信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'RobotName', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警机器人名称', + 'description' => 'IM机器人名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'robot名称', + ], + ], + [ + 'name' => 'Type', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警机器人类型:dingding/wechat', + 'description' => 'IM机器人类型：'."\n" + ."\n" + .'- `dingding`：钉钉机器人。'."\n" + .'- `wechat`：企业微信机器人。'."\n" + .'- `feishu`：飞书机器人。', + 'type' => 'string', + 'required' => true, + 'example' => 'dingding', + ], + ], + [ + 'name' => 'RobotAddress', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警机器人地址', + 'description' => 'IM机器人的Webhook地址。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', + ], + ], + [ + 'name' => 'DailyNoc', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否发送每日统计信息', + 'description' => '是否发送每日统计信息。'."\n" + ."\n" + .'- `false`（默认）：不发送统计信息。'."\n" + .'- `true`：发送统计信息。选择`true`后，**DailyNocTime**参数必填。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'DailyNocTime', + 'in' => 'formData', + 'schema' => [ + 'title' => '每日统计发送时间', + 'description' => '每日统计信息发送的时间点，使用半角逗号（,）分隔多个发送时间点，时间点格式为HH:SS。ARMS告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。', + 'type' => 'string', + 'required' => false, + 'example' => '09:30,17:00', + ], + ], + [ + 'name' => 'DingSignKey', + 'in' => 'formData', + 'schema' => [ + 'description' => '钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥，默认使用关键字白名单的方式进行认证，白名单关键字为**告警**。'."\n" + .'<props="china">更多信息，请参见[钉钉官方文档](https://open.dingtalk.com/document/robots/customize-robot-security-settings)。</props>'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '******', + ], + ], + [ + 'name' => 'Token', + 'in' => 'formData', + 'schema' => [ + 'description' => '开启Outgoing机制需要的Token。'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '1656558719183be1245ab44********', + ], + ], + [ + 'name' => 'EnableOutgoing', + 'in' => 'formData', + 'schema' => [ + 'description' => '是否开启Outgoing机制。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'CardTemplate', + 'in' => 'formData', + 'schema' => [ + 'title' => '卡片模版配置信息', + 'description' => '告警卡片模版配置信息。模板中各参数含义请参见下方补充说明。', + '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', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + 'AlertRobot' => [ + 'description' => '返回AlertRobot对象。', + 'type' => 'object', + 'properties' => [ + 'RobotId' => [ + 'title' => '告警机器人ID', + 'description' => 'IM机器人ID。填写该参数代表修改机器人信息。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'RobotName' => [ + 'title' => '告警机器人名称', + 'description' => 'IM机器人名称。', + 'type' => 'string', + 'example' => 'robot名称', + ], + 'Type' => [ + 'title' => '告警机器人类型:dingding/wechat', + 'description' => 'IM机器人类型：'."\n" + ."\n" + .'- `dingding`：钉钉机器人。'."\n" + .'- `wechat`：企业微信机器人。', + 'type' => 'string', + 'example' => 'dingding', + ], + 'RobotAddress' => [ + 'title' => '告警机器人地址', + 'description' => 'IM机器人的Webhook地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', + ], + 'DailyNoc' => [ + 'title' => '是否发送每日统计信息', + 'description' => '是否发送每日统计信息。'."\n" + ."\n" + .'- `false`（默认）：不发送统计信息。'."\n" + .'- `true`：发送统计信息。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DailyNocTime' => [ + 'title' => '每日统计发送时间', + 'description' => '每日统计信息发送的时间点。ARMS告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。', + 'type' => 'string', + 'example' => '09:30,17:00', + ], + 'Token' => [ + 'description' => '开启Outgoing机制需要的Token。', + 'type' => 'string', + 'example' => '1656558719183be1245ab44********'."\n", + ], + 'EnableOutgoing' => [ + 'description' => '是否开启Outgoing机制。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'CardTemplate' => [ + 'title' => '卡片模版配置信息', + 'description' => '告警卡片模版配置信息。', + '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 } ] }', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建或更新IM机器人', + 'requestParamsDescription' => '### CardTemplate参数说明'."\n" + .'模板示例：'."\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" + ."\n" + .'- fieldName：告警卡片中的字段名称。包含字段如下：'."\n" + .' - notificationPolicy：通知策略'."\n" + .' - alarmName：告警名称 '."\n" + .' - alarmContent：告警内容 '."\n" + .' - alarmTime：告警时间 '."\n" + .' - includeEvent：包含事件的数量 '."\n" + .' - assigned：通知人 '."\n" + .' - operator：告警处理人 '."\n" + .' - similarAlarm：上次相似告警 '."\n" + .' - seriesChart：告警指标趋势图 '."\n" + .'- visible：发送的告警卡片上对应字段内容是否可见。'."\n" + ."\n" + .' - true：可见'."\n" + .' - false：隐藏'."\n" + ."\n" + .'- button：卡片中的设置按钮，参数顺序对应卡片按钮顺序。按钮有以下几种：'."\n" + .' - claim：认领告警按钮 '."\n" + .' - close：解决告警按钮 '."\n" + .' - follow：关注告警按钮 '."\n" + .' - send_itsm：推送告警按钮 '."\n" + .' - block：屏蔽告警按钮 '."\n" + .' - unResolvedIncident：未解决告警按钮 ', + ], + 'DeleteIMRobot' => [ + 'summary' => '删除IM机器人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RobotId', + 'in' => 'query', + 'schema' => [ + 'title' => '告警机器人ID', + 'description' => 'IM机器人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'IsSuccess' => [ + 'description' => '是否成功删除IM机器人。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + ."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除IM机器人', + ], + 'DescribeIMRobots' => [ + 'summary' => '查询IM机器人列表。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RobotName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警机器人名称', + 'description' => 'IM机器人名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'robot名称', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页展示的IM机器人数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'RobotIds', + 'in' => 'query', + 'schema' => [ + 'description' => '机器人ID列表。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的IM机器人总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每一页数目', + 'description' => '每页的IM机器人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'AlertIMRobots' => [ + 'description' => 'IM机器人详情。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RobotId' => [ + 'title' => '告警机器人ID', + 'description' => 'IM机器人ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'Type' => [ + 'title' => '告警机器人类型', + 'description' => 'IM机器人类型：'."\n" + ."\n" + .'- `dingding`：钉钉机器人。'."\n" + .'- `wechat`：企业微信机器人。', + 'type' => 'string', + 'example' => 'dingding', + ], + 'RobotName' => [ + 'title' => '告警机器人名称', + 'description' => 'IM机器人名称。', + 'type' => 'string', + 'example' => 'robot名称', + ], + 'RobotAddr' => [ + 'title' => '告警机器人地址', + 'description' => 'IM机器人的Webhook地址。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', + ], + 'DailyNoc' => [ + 'title' => '是否发送每日统计信息', + 'description' => '是否发送每日统计信息。'."\n" + ."\n" + .'- `false`（默认）：不发送统计信息。'."\n" + .'- `true`：发送统计信息。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DailyNocTime' => [ + 'title' => '每日统计发送时间', + 'description' => '每日统计信息发送的时间点。ARMS告警管理将在设置的时间点发送今日产生告警的总数、解决数和待解决数。', + 'type' => 'string', + 'example' => '09:30,17:30', + ], + 'DingSignKey' => [ + 'description' => '钉钉签名密钥。如配置了密钥则会通过加签的方式进行钉钉认证。如果没有配置密钥，默认使用关键字白名单的方式进行认证，白名单关键字为**告警**。'."\n" + .'<props="china">更多信息，请参见[钉钉官方文档](https://open.dingtalk.com/document/robots/customize-robot-security-settings)。</props>', + 'type' => 'string', + 'example' => '******', + ], + 'CreateTime' => [ + 'description' => 'IM机器人的创建时间。', + 'type' => 'string', + 'example' => '2023-01-16 17:21:48', + ], + 'DispatchRules' => [ + 'description' => '通知策略。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'id' => [ + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '12345', + ], + 'name' => [ + 'description' => '通知策略名称。', + 'type' => 'string', + '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' => '查询IM机器人列表', + ], + 'CreateOrUpdateWebhookContact' => [ + 'summary' => '创建或修改Webhook告警联系人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'WebhookId', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警webhook ID', + 'description' => 'Webhook告警联系人ID。'."\n" + ."\n" + .'- 不填代表创建新的Webhook告警联系人。'."\n" + .'- 填写代表修改指定Webhook告警联系人信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'WebhookName', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警webhook名称', + 'description' => 'Webhook告警联系人名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'Webhook告警', + ], + ], + [ + 'name' => 'Method', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Http请求方法', + 'description' => 'HTTP请求方法。'."\n" + ."\n" + .'- Post'."\n" + ."\n" + .'- Get', + 'type' => 'string', + 'required' => true, + 'example' => 'Post', + ], + ], + [ + 'name' => 'Url', + 'in' => 'formData', + 'schema' => [ + 'title' => 'Url', + 'description' => '**Method**的请求方法URL。', + 'type' => 'string', + 'required' => true, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', + ], + ], + [ + 'name' => 'BizHeaders', + 'in' => 'formData', + 'schema' => [ + 'title' => 'http请求头', + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Content-Type":"application/json;charset=utf-8"}]', + ], + ], + [ + 'name' => 'BizParams', + 'in' => 'formData', + 'schema' => [ + 'title' => 'http请求参数', + 'description' => 'HTTP请求参数。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"content":"mike"}]', + ], + ], + [ + 'name' => 'Body', + 'in' => 'formData', + 'schema' => [ + 'title' => '告警通知模板', + 'description' => '告警触发时发送的通知模板，当**Method**设置为**Post**时必填，可使用`$content`占位符输出通知内容，不可超过500个字符。更多信息，请参见[通知模板的变量说明](~~251834~~)。', + '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' => '告警恢复时发送的通知模板，当**Method**设置为**Post**时必填，可使用`$content`占位符输出通知内容，不可超过500个字符。更多信息，请参见[通知模板的变量说明](~~251834~~)。', + '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' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + 'WebhookContact' => [ + 'description' => '返回的WebhookContact对象。', + 'type' => 'object', + 'properties' => [ + 'WebhookId' => [ + 'title' => '告警webhook ID', + 'description' => 'Webhook告警联系人ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'WebhookName' => [ + 'title' => '告警webhook名称', + 'description' => 'Webhook告警联系人名称。', + 'type' => 'string', + 'example' => 'Webhook告警', + ], + 'Webhook' => [ + 'description' => '返回的Webhook对象。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => 'Http请求方法', + 'description' => 'HTTP请求方法。'."\n" + ."\n" + .'- Post'."\n" + ."\n" + .'- Get', + 'type' => 'string', + 'example' => 'Post', + ], + 'Url' => [ + 'title' => 'url', + 'description' => '请求方法URL。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121******', + ], + 'BizHeaders' => [ + 'title' => 'http请求头', + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'example' => '[{"Content-Type":"application/json;charset=utf-8"}]', + ], + 'BizParams' => [ + 'title' => 'http请求参数', + 'description' => 'HTTP请求参数。', + 'type' => 'string', + 'example' => '[{"content":"mike"}]', + ], + 'Body' => [ + 'title' => '告警通知模板', + 'description' => '告警通知模板。', + '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' => '告警恢复模板。', + '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 }}" }', + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '创建或修改Webhook告警联系人', + ], + 'DeleteWebhookContact' => [ + 'summary' => '删除Webhook告警联系人。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'WebhookId', + 'in' => 'query', + 'schema' => [ + 'title' => '告警webhookID', + 'description' => 'Webhook告警联系人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + 'IsSuccess' => [ + 'description' => '是否成功删除Webhook告警联系人。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + ."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除Webhook告警联系人', + ], + 'DescribeWebhookContacts' => [ + 'summary' => '查询Webhook告警联系人列表。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '118619', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'WebhookName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警webhook名称', + 'description' => 'Webhook告警联系人名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'webhook名称', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页展示的Webhook告警联系人数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人ID。', + 'type' => 'string', + 'required' => false, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的Webhook告警联系人总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每一页数目', + 'description' => '每页的Webhook告警联系人数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'WebhookContacts' => [ + 'title' => '告警webhook联系人列表', + 'description' => 'Webhook告警联系人列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'WebhookId' => [ + 'title' => '告警webhookID', + 'description' => 'Webhook告警联系人ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '123', + ], + 'WebhookName' => [ + 'title' => '告警webhook名称', + 'description' => 'Webhook告警联系人名称。', + 'type' => 'string', + 'example' => 'webhook名称', + ], + 'Webhook' => [ + 'title' => 'webhook对象', + 'description' => 'Webhook告警联系人详情。', + 'type' => 'object', + 'properties' => [ + 'Method' => [ + 'title' => 'http请求方式', + 'description' => 'HTTP请求方法。'."\n" + ."\n" + .'- Get'."\n" + ."\n" + .'- Post', + 'type' => 'string', + 'example' => 'Post', + ], + 'Url' => [ + 'title' => 'Url', + 'description' => '请求方法URL。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', + ], + 'BizHeaders' => [ + 'title' => 'HTTP请求头', + 'description' => 'HTTP请求头。', + 'type' => 'object', + 'example' => '[{"Content-Type":"application/json"}]', + ], + 'BizParams' => [ + 'title' => 'HTTP请求参数', + 'description' => 'HTTP请求参数。', + 'type' => 'object', + 'example' => '[{"content:"mike"}]', + ], + 'Body' => [ + 'title' => '告警通知模板', + 'description' => '告警通知模板。', + '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' => '告警恢复模板。', + '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 }}" }', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询Webhook告警联系人列表', + ], + 'CreateOrUpdateEventBridgeIntegration' => [ + 'summary' => '创建或修改EventBridge通知集成。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '通知集成ID。'."\n" + ."\n" + .'- 不填代表创建新的通知集成。'."\n" + .'- 填写代表修改指定通知集成信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'description' => 'EventBridge通知集成名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'EventBridge_Test', + ], + ], + [ + 'name' => 'Description', + 'in' => 'formData', + 'schema' => [ + 'description' => '通知集成描述信息。', + 'type' => 'string', + 'required' => false, + 'example' => 'test', + ], + ], + [ + 'name' => 'Endpoint', + 'in' => 'formData', + 'schema' => [ + 'description' => 'EventBridge公网地址。', + 'type' => 'string', + 'required' => false, + 'example' => 'http://xxxxx', + ], + ], + [ + 'name' => 'AccessKey', + 'in' => 'formData', + 'schema' => [ + 'description' => 'EventBridge AccessKey ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc******************', + ], + ], + [ + 'name' => 'AccessSecret', + 'in' => 'formData', + 'schema' => [ + 'description' => 'EventBridge AccessKey Secret。', + 'type' => 'string', + 'required' => false, + 'example' => 'abc******************', + ], + ], + [ + 'name' => 'EventBusName', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件总线名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'EventBus_Test', + ], + ], + [ + 'name' => 'Source', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件来源。', + 'type' => 'string', + 'required' => false, + 'example' => 'arms', + ], + ], + [ + 'name' => 'EventBusRegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '事件总线所在地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B289756-E791-5842-BCBD-AD414C******', + ], + 'EventBridgeIntegration' => [ + 'description' => 'EventBridge通知集成信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'EventBridge通知集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'description' => 'EventBridge通知集成名称。', + 'type' => 'string', + 'example' => 'EventBridge_Test', + ], + 'Description' => [ + 'description' => '通知集成描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + 'Endpoint' => [ + 'description' => 'EventBridge公网地址。', + 'type' => 'string', + 'example' => 'http://xxxxx', + ], + 'AccessKey' => [ + 'description' => 'EventBridge AccessKey ID。', + 'type' => 'string', + 'example' => 'abc******************', + ], + 'AccessSecret' => [ + 'description' => 'EventBridge AccessKey Secret。', + 'type' => 'string', + 'example' => 'abc******************', + ], + 'EventBusName' => [ + 'description' => '事件总线名称。', + 'type' => 'string', + 'example' => 'EventBus_Test', + ], + 'Source' => [ + 'description' => '事件来源。', + 'type' => 'string', + 'example' => 'arms', + ], + 'EventBusRegionId' => [ + 'description' => '事件总线所在地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + ], + ], + ], + ], + ], + ], + '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' => '创建或修改EventBridge通知集成', + ], + 'DeleteEventBridgeIntegration' => [ + 'summary' => '删除EventBridge通知集成。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '133880', + 'abilityTreeNodes' => [ + 'FEATUREarmsR0R9WE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'description' => '必填，EventBridge通知集成ID，可通过**ListEventBridgeIntegrations**接口查询。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B289756-E791-5842-BCBD-AD414C******', + ], + 'IsSuccess' => [ + 'description' => 'EventBridge通知集成是否成功删除。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除EventBridge通知集成', + ], + 'ListEventBridgeIntegrations' => [ + 'summary' => '查询EventBridge通知集成信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'description' => '每页展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '15', + ], + ], + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => 'EventBridge通知集成名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'EventBridge_Test', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2B289756-E791-5842-BCBD-AD414C******', + ], + 'PageBean' => [ + 'description' => '每页EventBridge通知集成信息。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'description' => '查询到的EventBridge通知集成总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'description' => '查询到的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'description' => '每页展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'EventBridgeIntegrations' => [ + 'description' => 'EventBridge通知集成对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => 'EventBridge通知集成对象信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => 'EventBridge通知集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'description' => 'EventBridge通知集成名称。', + 'type' => 'string', + 'example' => 'EventBridge_Test', + ], + 'Description' => [ + 'description' => 'EventBridge通知集成描述信息。', + 'type' => 'string', + 'example' => 'test', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询EventBridge通知集成信息', + ], + 'CreateOrUpdateNotificationPolicy' => [ + 'summary' => '创建或更新通知策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '通知策略ID', + 'description' => '通知策略ID。'."\n" + ."\n" + .'- 不填代表创建新的通知策略。'."\n" + .'- 填写代表修改指定通知策略信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '通知策略名称', + 'description' => '通知策略名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'notificationpolicy_test', + ], + ], + [ + 'name' => 'MatchingRules', + 'in' => 'formData', + 'schema' => [ + 'title' => '事件匹配规则列表', + 'description' => '匹配告警事件规则。格式如下：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "matchingConditions": ['."\n" + .' { '."\n" + .' "value": "test", //匹配告警事件规则Value。'."\n" + .' "key": "alertname", //匹配告警事件规则Key。'."\n" + .' "operator": "eq" //规则聚合方式，包括eq（等于）、neq（不等于）、in（包含）、nin（不包含）、re（匹配正则）、nre（正则不匹配）。 '."\n" + .' }'."\n" + .' ]'."\n" + .' } '."\n" + .' ]'."\n" + .'```'."\n", + 'type' => 'string', + 'required' => false, + 'example' => '[ { "matchingConditions": [ { "value": "test", "key": "alertname", "operator": "eq" } ] } ]', + ], + ], + [ + 'name' => 'SendRecoverMessage', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否发送恢,不填默认为：true复通知', + 'description' => '当告警下面全部事件都恢复时，告警状态是否自动恢复为已解决。当告警恢复时，系统将会发送通知给处理人。'."\n" + ."\n" + .'- `true`（默认）：发送通知。'."\n" + .'- `false`：不发送通知。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'GroupRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '分组规则', + 'description' => '设置事件分组。'."\n" + .' '."\n" + ."\n" + .'- 不填（默认）：所有告警会按`alertname`分组发送给处理人。'."\n" + .'- 设置分组字段：相同字段的告警内容会分别通过独立信息发送给处理人。'."\n" + .'分组格式如下：'."\n" + ."\n" + .'```'."\n" + .'{ '."\n" + .'"groupWait":5, //分组等待时间。'."\n" + .'"groupInterval":30, //分组间隔时间。'."\n" + .'"groupingFields":["alertname"] //分组字段。'."\n" + .'}'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => '{ "groupWait":5, "groupInterval":30, "groupingFields":["alertname"] }', + ], + ], + [ + 'name' => 'NotifyRule', + 'in' => 'formData', + 'schema' => [ + 'title' => '通知规则,通知对象，必填', + 'description' => '设置通知规则。格式如下：'."\n" + .'```'."\n" + .'{ '."\n" + .' "notifyStartTime":"00:00", //通知时间段开始时间。'."\n" + .' "notifyEndTime":"23:59", //通知时间段结束时间。'."\n" + .' "notifyChannels":["dingTalk", "email", "sms", "tts", "webhook"], //通知方式，包括dingTalk(钉钉）、email（邮件）、sms（短信）、tts（电话）和webhook。'."\n" + .' "notifyObjects":[{ //通知对象。'."\n" + .' "notifyObjectType":"CONTACT", //通知对象类型，包括CONTACT（联系人）、CONTACT_GROUP（联系人组）、ARMS_CONTACT（ARMS联系人）、ARMS_CONTACT_GROUP（ARMS联系人组）、DING_ROBOT_GROUP（钉钉/飞书/企业微信 IM机器人）、CONTACT_SCHEDULE（排班表）。'."\n" + .' "notifyObjectId":123, //通知对象ID。'."\n" + .' "notifyObjectName":"test" //通知对象名称。'."\n" + .' "notifyChannels": [ //通知对象为联系人时单独指定的联系方式。包括email（邮件）、sms（短信）、tts（电话）'."\n" + .' "email", '."\n" + .' "sms",'."\n" + .' "tts"'."\n" + .' ],'."\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' => '通知模板。示例模板请参见表格下方说明。', + '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' => '升级规则ID', + 'description' => '升级规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Repeat', + 'in' => 'formData', + 'schema' => [ + 'title' => '是否重复通知,不填默认为true，需要必填重复通知时间间隔；false，需要必填升级规则ID', + 'description' => '对于长期未解决的告警是否发送重复通知。'."\n" + ."\n" + .'- `true`（默认）：设置为`true`后，必须设置**RepeatInterval**。'."\n" + .'- `false`：设置为`false`后，必须设置**EscalationPolicyId**。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RepeatInterval', + 'in' => 'formData', + 'schema' => [ + 'title' => '重复通知时间间隔,单位：s', + 'description' => '重复通知时间间隔，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '600', + ], + ], + [ + 'name' => 'IntegrationId', + 'in' => 'formData', + 'schema' => [ + 'title' => '集成ID', + 'description' => '告警需要推送到的工单系统，填写工单系统的集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '34', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'DirectedMode', + 'in' => 'formData', + 'schema' => [ + 'title' => '极简模式', + 'description' => '极简模式', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'State', + 'in' => 'formData', + 'schema' => [ + 'title' => '通知策略是否启用，enable 启用，disable 停用', + 'description' => '通知策略是否启用，enable 启用，disable 停用', + 'type' => 'string', + 'required' => false, + 'example' => 'enable', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'NotificationPolicy' => [ + 'title' => '通知策略对象', + 'description' => '通知策略对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '通知策略ID', + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'title' => '通知策略名称', + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => 'notificationpolicy_test', + ], + 'MatchingRules' => [ + 'title' => '事件匹配规则列表', + 'description' => '匹配告警事件规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'description' => '匹配条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '条件字段', + 'description' => '匹配条件Key。', + 'type' => 'string', + 'example' => 'altertname', + ], + 'Value' => [ + 'title' => '条件字段值', + 'description' => '匹配条件Value。', + 'type' => 'string', + 'example' => 'test', + ], + 'Operator' => [ + 'title' => '对应关系', + 'description' => '匹配条件聚合方式。'."\n" + ."\n" + .'- `eq`：等于'."\n" + .'- `neq`：不等于'."\n" + .'- `in`：包含'."\n" + .'- `nin`：不包含'."\n" + .'- `re`：匹配正则'."\n" + .'- `nre`：正则不匹配', + 'type' => 'string', + 'example' => 'eq', + ], + ], + ], + ], + ], + ], + ], + 'SendRecoverMessage' => [ + 'title' => '是否发送恢复通知', + 'description' => '当告警下面全部事件都恢复时，告警状态是否自动恢复为已解决。当告警恢复时，系统将会发送通知给处理人。'."\n" + ."\n" + .'- `true`（默认）：发送通知。'."\n" + .'- `false`：不发送通知。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GroupRule' => [ + 'title' => '分组规则', + 'description' => '事件分组。', + 'type' => 'object', + 'properties' => [ + 'GroupingFields' => [ + 'title' => '分组字段,为空则不分组，默认按照alertname分组', + 'description' => '设置事件分组。'."\n" + .' '."\n" + ."\n" + .'- 不填（默认）：所有告警会按`alertname`分组发送给处理人。'."\n" + .'- 设置分组字段：相同字段的告警内容会分别通过独立信息发送给处理人。', + 'type' => 'array', + 'items' => [ + 'description' => '分组字段。', + 'type' => 'string', + 'example' => '["alertName","clustname"]', + ], + ], + 'GroupWait' => [ + 'title' => '分组等待时间，选填，默认是5秒', + 'description' => '分组等待时间，默认为5秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'GroupInterval' => [ + 'title' => '分组间隔时间，选填，默认是30s', + 'description' => '分组间隔时间，默认为30秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + 'NotifyRule' => [ + 'title' => '通知规则', + 'description' => '通知规则。', + 'type' => 'object', + 'properties' => [ + 'NotifyStartTime' => [ + 'title' => '通知时间段开始时间', + 'description' => '通知时间段开始时间。', + 'type' => 'string', + 'example' => '00:00', + ], + 'NotifyEndTime' => [ + 'title' => '通知时间段结束时间', + 'description' => '通知时间段结束时间。', + 'type' => 'string', + 'example' => '23:59', + ], + 'NotifyChannels' => [ + 'title' => '通知渠道', + 'description' => '通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '通知方式。'."\n" + ."\n" + .'- `dingTalk`：钉钉'."\n" + .'- `email`：邮件'."\n" + .'- `sms`：短信'."\n" + .'- `tts`：电话'."\n" + .'- `webhook`：Webhook', + 'type' => 'string', + 'example' => '["dingTalk", "email", "sms", "tts", "webhook"]', + ], + ], + 'NotifyObjects' => [ + 'title' => '通知对象', + 'description' => '通知对象列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通知对象', + 'type' => 'object', + 'properties' => [ + 'NotifyObjectType' => [ + 'title' => '通知对象类型，CONTACT, CONTACT_GROUP, ARMS_CONTACT, DING_ROBOT', + 'description' => '通知对象类型。'."\n" + ."\n" + .'- CONTACT：联系人'."\n" + .'- CONTACT_GROUP：联系人组 '."\n" + .'- ARMS_CONTACT：ARMS联系人'."\n" + .'- ARMS_CONTACT_GROUP：ARMS联系人组'."\n" + .'- DING_ROBOT_GROUP：钉钉/飞书/企业微信 IM机器人'."\n" + .'- CONTACT_SCHEDULE：排班表', + 'type' => 'string', + 'example' => 'CONTACT', + ], + 'NotifyObjectId' => [ + 'title' => '通知对象ID', + 'description' => '通知对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'NotifyObjectName' => [ + 'title' => '通知对象名称', + 'description' => '通知对象名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'NotifyChannels' => [ + 'title' => '通知对象为联系人时的联系方式', + 'description' => '通知对象为联系人时的单独的联系方式', + 'type' => 'array', + 'items' => [ + 'title' => '', + 'description' => '通知方式。'."\n" + ."\n" + .'- `email`：邮件'."\n" + .'- `sms`：短信'."\n" + .'- `tts`：电话', + 'type' => 'string', + 'example' => 'sms', + ], + ], + ], + ], + ], + ], + ], + 'NotifyTemplate' => [ + 'title' => '通知模板', + 'description' => '通知模板。', + 'type' => 'object', + 'properties' => [ + 'EmailTitle' => [ + 'title' => '邮件标题', + 'description' => '邮件告警通知标题。', + 'type' => 'string', + 'example' => '{{ .commonLabels.alertname }}', + ], + 'EmailContent' => [ + 'title' => '邮件内容', + 'description' => '邮件告警通知内容。', + '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' => '邮件告警恢复通知标题。', + 'type' => 'string', + 'example' => '{{ .commonLabels.alertname }}', + ], + 'EmailRecoverContent' => [ + 'title' => '恢复告警邮件内容', + 'description' => '邮件告警恢复通知内容。', + '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' => '短信告警通知内容。', + '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' => '短信告警恢复通知内容。', + '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' => '电话告警通知内容。', + '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' => '电话告警恢复通知内容。', + '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' => '机器人告警通知内容。', + '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}}', + ], + ], + ], + 'EscalationPolicyId' => [ + 'title' => '升级规则ID', + 'description' => '升级规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Repeat' => [ + 'title' => '是否重复通知', + 'description' => '对于长期未解决的告警是否发送重复通知。'."\n" + ."\n" + .'- `true`（默认）：按设置的重复通知时间间隔发送通知。'."\n" + .'- `false`：根据设置升级策略发送通知。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RepeatInterval' => [ + 'title' => '重复通知时间间隔', + 'description' => '重复通知时间间隔，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600', + ], + 'IntegrationId' => [ + 'title' => '集成ID', + 'description' => '告警需要推送到的工单系统，显示为工单系统的集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + 'DirectedMode' => [ + 'title' => '极简模式', + 'description' => '极简模式', + 'type' => 'boolean', + ], + 'State' => [ + 'title' => '通知策略是否启用，enable 启用，disable 停用', + 'description' => '通知策略是否启用，enable 启用，disable 停用', + 'type' => 'string', + 'example' => 'enable', + ], + ], + ], + ], + ], + ], + ], + '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' => '新增及修改通知策略', + 'requestParamsDescription' => '### NotifyTemplate默认通知模板示例'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .'//邮件告警通知'."\n" + .'"emailTitle":"{{ .commonLabels.alertname }}",'."\n" + ."\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" + ."\n" + .'//邮件告警恢复通知'."\n" + .'"emailRecoverTitle":"{{ .commonLabels.alertname }}",'."\n" + ."\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" + ."\n" + .'//短信告警通知'."\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" + ."\n" + .'//短信告警恢复通知'."\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" + ."\n" + .'//电话告警通知'."\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" + ."\n" + .'//电话告警恢复通知'."\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" + ."\n" + .'//机器人告警通知'."\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" + .'}'."\n" + .'```', + ], + 'DeleteNotificationPolicy' => [ + 'summary' => '根据通知策略ID删除通知策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '通知策略ID', + 'description' => '通知策略ID。'."\n" + ."\n" + .'获取通知策略ID，请参见[ListNotificationPolicies - 查询通知策略信息](~~2612375~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'IsSuccess' => [ + 'description' => '通知策略是否删除成功。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除通知策略', + ], + 'ListNotificationPolicies' => [ + 'summary' => '通过指定条件查询通知策略信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '通知策略名称', + 'description' => '通知策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'notificationpolicy_test', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示数目', + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询详情信息', + 'description' => '是否查询通知策略详情。'."\n" + ."\n" + .'- `true`：查询。'."\n" + .'- `false`：不查询。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域id。默认为**cn-hangzhou**。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Ids', + 'in' => 'query', + 'schema' => [ + 'description' => '通知策略ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'DirectedMode', + 'in' => 'query', + 'schema' => [ + 'title' => '极简模式', + 'description' => '极简模式', + 'type' => 'boolean', + 'required' => false, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的通知策略总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '24', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询到的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每页展示数目', + 'description' => '每页展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'NotificationPolicies' => [ + 'title' => '通知策略对象', + 'description' => '通知策略信息。', + 'type' => 'array', + 'items' => [ + 'description' => '通知策略对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '通知策略ID', + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'title' => '通知策略名称', + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => 'notificationpolicy_test', + ], + 'MatchingRules' => [ + 'title' => '事件匹配规则列表', + 'description' => '匹配告警事件规则。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'title' => '匹配条件', + 'description' => '匹配条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '条件字段', + 'description' => '匹配条件Key。', + 'type' => 'string', + 'example' => 'altertname', + ], + 'Value' => [ + 'title' => '条件字段值', + 'description' => '匹配条件Value。', + 'type' => 'string', + 'example' => 'test', + ], + 'Operator' => [ + 'title' => '对应关系', + 'description' => '匹配条件聚合方式。'."\n" + ."\n" + .'- `eq`：等于'."\n" + .'- `neq`：不等于'."\n" + .'- `in`：包含'."\n" + .'- `nin`：不包含'."\n" + .'- `re`：匹配正则'."\n" + .'- `nre`：正则不匹配', + 'type' => 'string', + 'example' => 'eq', + ], + ], + ], + ], + ], + ], + ], + 'SendRecoverMessage' => [ + 'title' => '是否发送恢复通知', + 'description' => '当告警下面全部事件都恢复时，告警状态是否自动恢复为已解决。当告警恢复时，系统将会发送通知给处理人。'."\n" + ."\n" + .'- `true`（默认）：发送通知。'."\n" + .'- `false`：不发送通知。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'GroupRule' => [ + 'title' => '分组规则', + 'description' => '事件分组。', + 'type' => 'object', + 'properties' => [ + 'GroupingFields' => [ + 'title' => '分组字段,为空则不分组，默认按照alertname分组', + 'description' => '设置事件分组。'."\n" + .' '."\n" + ."\n" + .'- 不填（默认）：所有告警会按`alertname`分组发送给处理人。'."\n" + .'- 设置分组字段：相同字段的告警内容会分别通过独立信息发送给处理人。', + 'type' => 'array', + 'items' => [ + 'description' => '分组字段。', + 'type' => 'string', + 'example' => '["alertname"]', + ], + ], + 'GroupWait' => [ + 'title' => '分组等待时间，选填，默认是5秒', + 'description' => '分组等待时间，默认为5秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '5', + ], + 'GroupInterval' => [ + 'title' => '分组间隔时间，选填，默认是30s', + 'description' => '分组间隔时间，默认为30秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '30', + ], + ], + ], + 'NotifyRule' => [ + 'title' => '通知规则', + 'description' => '通知规则。', + 'type' => 'object', + 'properties' => [ + 'NotifyStartTime' => [ + 'title' => '通知时间段开始时间', + 'description' => '通知时间段开始时间。', + 'type' => 'string', + 'example' => '00:00', + ], + 'NotifyEndTime' => [ + 'title' => '通知时间段结束时间', + 'description' => '通知时间段结束时间。', + 'type' => 'string', + 'example' => '23:59', + ], + 'NotifyChannels' => [ + 'title' => '通知渠道', + 'description' => '通知方式。', + 'type' => 'array', + 'items' => [ + 'description' => '通知方式。'."\n" + ."\n" + .'- `dingTalk`：钉钉'."\n" + .'- `email`：邮件'."\n" + .'- `sms`：短信'."\n" + .'- `tts`：电话'."\n" + .'- `webhook`：Webhook', + 'type' => 'string', + 'example' => '[ "dingTalk", "email", "sms", "tts","webhook" ]', + ], + ], + 'NotifyObjects' => [ + 'title' => '通知对象', + 'description' => '通知对象。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyObjectType' => [ + 'title' => '通知对象类型，CONTACT, CONTACT_GROUP, ARMS_CONTACT, DING_ROBOT', + 'description' => '通知对象类型。'."\n" + ."\n" + .'- CONTACT：联系人'."\n" + .'- CONTACT_GROUP：联系人组 '."\n" + .'- DING_ROBOT：IM机器人'."\n" + .'- CONTACT_SCHEDULE：排班表', + 'type' => 'string', + 'example' => 'CONTACT', + ], + 'NotifyObjectId' => [ + 'title' => '通知对象ID', + 'description' => '通知对象ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'NotifyObjectName' => [ + 'title' => '通知对象名称', + 'description' => '通知对象名称。', + 'type' => 'string', + 'example' => 'test', + ], + 'NotifyChannels' => [ + 'title' => '通知对象为联系人时的联系方式', + 'description' => '通知对象为联系人时单独的联系方式', + 'type' => 'array', + 'items' => [ + 'description' => '通知方式。'."\n" + ."\n\n" + .'- `email`：邮件'."\n" + .'- `sms`：短信'."\n" + .'- `tts`：电话', + 'type' => 'string', + 'example' => '[ "email", "sms", "tts" ]', + ], + ], + ], + ], + ], + ], + ], + 'NotifyTemplate' => [ + 'title' => '通知模板', + 'description' => '通知模板。', + 'type' => 'object', + 'properties' => [ + 'EmailTitle' => [ + 'title' => '邮件标题', + 'description' => '邮件告警通知标题。', + 'type' => 'string', + 'example' => '{{ .commonLabels.alertname }}', + ], + 'EmailContent' => [ + 'title' => '邮件内容', + 'description' => '邮件告警通知内容。', + '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' => '邮件告警恢复通知标题。', + 'type' => 'string', + 'example' => '{{ .commonLabels.alertname }}', + ], + 'EmailRecoverContent' => [ + 'title' => '恢复告警邮件内容', + 'description' => '邮件告警恢复通知内容。', + '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' => '短信告警通知内容。', + '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' => '短信告警恢复通知内容。', + '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' => '电话告警通知内容。', + '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' => '电话告警恢复通知内容。', + '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' => '机器人告警通知内容。', + '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}}', + ], + ], + ], + 'Repeat' => [ + 'title' => '是否重复通知', + 'description' => '对于长期未解决的告警是否发送重复通知。'."\n" + ."\n" + .'- `true`（默认）：按设置的重复通知时间间隔发送通知。'."\n" + .'- `false`：根据设置升级策略发送通知。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RepeatInterval' => [ + 'title' => '重复通知时间间隔', + 'description' => '重复通知时间间隔，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '600', + ], + 'EscalationPolicyId' => [ + 'title' => '升级规则ID', + 'description' => '升级规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'IntegrationId' => [ + 'title' => '集成ID', + 'description' => '告警需要推送到的工单系统，显示为工单系统的集成ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '34', + ], + 'DirectedMode' => [ + 'title' => '极简模式', + 'description' => '极简模式', + 'type' => 'boolean', + ], + 'State' => [ + 'title' => '通知策略是否启用，enable 启用，disable 停用', + 'description' => '通知策略是否启用，enable 启用，disable 停用', + 'type' => 'string', + 'example' => 'enable', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询通知策略信息', + ], + 'CreateOrUpdateSilencePolicy' => [ + 'summary' => '创建或修改静默策略。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'formData', + 'schema' => [ + 'title' => '静默策略ID', + 'description' => '静默策略ID。'."\n" + ."\n" + .'- 不填代表创建新的静默策略。'."\n" + .'- 填写代表修改指定静默策略信息。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '1234', + ], + ], + [ + 'name' => 'Name', + 'in' => 'formData', + 'schema' => [ + 'title' => '静默策略名称', + 'description' => '静默策略名称。', + 'type' => 'string', + 'required' => true, + 'example' => 'silencepolicy_test', + ], + ], + [ + 'name' => 'MatchingRules', + 'in' => 'formData', + 'schema' => [ + 'title' => '分派规则', + 'description' => '设置分派规则。格式如下：'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + .' "matchingConditions": ['."\n" + .' {'."\n" + .' "value": "test", //分派规则条件Value。'."\n" + .' "key": "altertname", //分派规则条件Key。'."\n" + .' "operator": "eq" //分派规则条件聚合方式，包括eq（等于）、neq（不等于）、in（包含）、nin（不包含）、re（匹配正则）、nre（正则不匹配）。 '."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .'```', + 'type' => 'string', + 'required' => false, + 'example' => '[ { "matchingConditions": [ { "value": "test", "key": "altertname", "operator": "eq" } ] } ]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'formData', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + [ + 'name' => 'State', + 'in' => 'formData', + 'schema' => [ + 'title' => '静默策略是否启用，enable 启用，disable 停用', + 'description' => '静默策略是否启用，enable 启用，disable 停用', + 'type' => 'string', + 'required' => false, + 'example' => 'enable', + ], + ], + [ + 'name' => 'EffectiveTimeType', + 'in' => 'query', + 'allowEmptyValue' => false, + 'schema' => [ + 'description' => '静默策略生效时间类型，PERMANENT - 永久生效，CUSTOM_TIME - 自定义时间段生效，CYCLE_EFFECT - 循环生效。', + 'type' => 'string', + 'required' => false, + 'example' => 'PERMANENT', + 'default' => 'PERMANENT', + 'enum' => [ + 'PERMANENT', + 'CYCLE_EFFECT', + 'CUSTOM_TIME', + ], + ], + ], + [ + 'name' => 'TimePeriod', + 'in' => 'query', + 'allowEmptyValue' => true, + 'schema' => [ + 'description' => '循环周期，当静默策略生效类型为CYCLE_EFFECT（循环生效）时必填。DAY-按天循环，WEEK-按周循环。', + 'type' => 'string', + 'required' => false, + 'example' => 'DAY', + 'enum' => [ + 'DAY', + 'WEEK', + ], + ], + ], + [ + 'name' => 'TimeSlots', + 'in' => 'query', + 'schema' => [ + 'description' => '通知策略生效时间段。当生效时间类型为CUSTOM_TIME(自定义时间段时)，输入格式为[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}]。当生效时间类型为CYCLE_EFFECT（循环生效），且循环周期是DAY(按天循环)时，输入格式为[{"startTime":"22:13","endTime":"22:21"}]（开始时间不能小于结束时间）。当生效时间类型为CYCLE_EFFECT（循环生效），且循环周期是WEEK(按周循环)时，输入格式为[{"startWeek":"1", "endWeek":"2" "startTime":"22:13","endTime":"22:21"}]（week参数取值为1-7，且开始时间不能小于结束时间）。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"startTime":"2024-08-04 22:13","endTime":"2024-08-04 22:21"}]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'SilencePolicy' => [ + 'title' => '静默策略对象', + 'description' => '静默策略对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '静默策略ID', + 'description' => '静默策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'title' => '静默策略名称', + 'description' => '静默策略名称。', + 'type' => 'string', + 'example' => 'silencepolicy_test', + ], + 'MatchingRules' => [ + 'title' => '分派规则', + 'description' => '分派规则。', + 'type' => 'array', + 'items' => [ + 'description' => '分派规则对象。', + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'title' => '分派条件', + 'description' => '分派规则条件。', + 'type' => 'array', + 'items' => [ + 'description' => '分派条件对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '条件字段', + 'description' => '分派规则条件Key。', + 'type' => 'string', + 'example' => 'altertname', + ], + 'Value' => [ + 'title' => '条件字段值', + 'description' => '分派规则条件Value。', + 'type' => 'string', + 'example' => 'test', + ], + 'Operator' => [ + 'title' => '对应关系', + 'description' => '分派规则条件聚合方式。'."\n" + ."\n" + .'- `eq`：等于'."\n" + .'- `neq`：不等于'."\n" + .'- `in`：包含'."\n" + .'- `nin`：不包含'."\n" + .'- `re`：匹配正则'."\n" + .'- `nre`：正则不匹配', + 'type' => 'string', + 'example' => 'eq', + ], + ], + ], + ], + ], + ], + ], + 'State' => [ + 'title' => '静默策略是否启用，enable 启用，disable 停用', + 'description' => '静默策略是否启用，enable 启用，disable 停用', + 'type' => 'string', + 'example' => 'enable', + ], + 'EffectiveTimeType' => [ + 'description' => '生效类型, 取值范围如下 '."\n" + .'PERMANENT: 永久生效 '."\n" + .'CYCLE_EFFECT: 循环生效 '."\n" + .'CUSTOM_TIME:自定义时间段', + 'type' => 'string', + 'example' => 'PERMANENT', + ], + 'TimePeriod' => [ + 'description' => '生效周期 '."\n" + .'DAY 每日 '."\n" + .'WEEK 每周', + 'type' => 'string', + 'example' => 'WEEK', + ], + 'TimeSlots' => [ + 'description' => '静默规则生效时间段', + 'type' => 'string', + 'example' => '[{startWeek: "1", startTime: "00:00", endTime: "11:59", endWeek:"7"}]'."\n", + ], + ], + ], + ], + ], + ], + ], + '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' => '新增及修改静默策略', + ], + 'DeleteSilencePolicy' => [ + 'summary' => '调用DeleteSilencePolicy接口根据静默策略ID删除静默策略。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '静默策略ID', + 'description' => '静默策略ID。'."\n" + ."\n" + .'获取静默策略 ID，请参见[ListSilencePolicies - 静默策略列表信息](~~2612383~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + 'IsSuccess' => [ + 'title' => '删除静默策略是否成功', + 'description' => '静默策略是否成功删除。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + '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' => '删除静默策略', + ], + 'ListEscalationPolicies' => [ + 'summary' => '调用ListEscalationPolicies接口查询升级策略信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '升级策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod升级策略', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示数目', + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每页展示数目', + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'EscalationPolicies' => [ + 'description' => '升级策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '升级策略对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '升级策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'description' => '升级策略名称。', + 'type' => 'string', + 'example' => 'prod升级策略', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询升级策略信息', + ], + 'ListOnCallSchedules' => [ + 'summary' => '调用ListOnCallSchedules接口查询排班策略信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '排班策略名称', + 'description' => '排班策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'OnCallSchedule_test', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '展示数目', + 'description' => '展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每页展示数目', + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'OnCallSchedules' => [ + 'description' => '排班策略信息列表。', + 'type' => 'array', + 'items' => [ + 'description' => '排班策略信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '排班策略ID', + 'description' => '排班策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'title' => '排班策略名称', + 'description' => '排班策略名称。', + 'type' => 'string', + 'example' => 'OnCallSchedule_test', + ], + 'Description' => [ + 'title' => '排班策略描述', + 'description' => '排班策略描述。', + 'type' => 'string', + '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' => '查询排班策略', + ], + 'GetOnCallSchedulesDetail' => [ + 'summary' => '调用GetOnCallSchedulesDetail接口查询排班策略信息。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'title' => '排班策略ID', + 'description' => '排班策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1234', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询排班人开始时间:yyyy-MM-dd', + 'description' => '开始值班时间，格式为`yyyy-MM-dd`。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-01', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => 'String.Class 查询排班人结束时间:yyyy-MM-dd', + 'description' => '结束值班时间，格式为`yyyy-MM-dd`。', + 'type' => 'string', + 'required' => false, + 'example' => '2022-10-30', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'Data' => [ + 'title' => '排班策略详情信息', + 'description' => '排班策略详细信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '排班策略ID', + 'description' => '排班策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234', + ], + 'Name' => [ + 'title' => '排名策略名称', + 'description' => '排名策略名称。', + 'type' => 'string', + 'example' => '排班策略测试', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '排班策略描述信息。', + 'type' => 'string', + 'example' => '测试', + ], + 'AlertRobotId' => [ + 'description' => '换班通知的钉钉机器人地址。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=69d4e009547e11069c6513309414937b7bf0482fb9284125b5******', + ], + 'ScheduleLayers' => [ + 'description' => '值班班次。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'ContactIds' => [ + 'description' => '排班人员ID列表。', + 'type' => 'array', + 'items' => [ + 'description' => '排班人员ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '[123, 234, 456]', + ], + ], + 'StartTime' => [ + 'description' => '换班生效起始时间。', + 'type' => 'string', + 'example' => '2022-10-01'."\n", + ], + 'ShiftLength' => [ + 'description' => '换班周期，单位为小时。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '8', + ], + 'RotationType' => [ + 'description' => '换班类型：'."\n" + ."\n" + .'- DAY： 天 '."\n" + .'- WEEK： 周 '."\n" + .'- CUSTOM： 自定义 ', + 'type' => 'string', + 'example' => 'DAY', + ], + 'Restrictions' => [ + 'description' => '排班限制时间。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RestrictionType' => [ + 'description' => '限制时间类型：'."\n" + ."\n" + .'- daily_restriction：天'."\n" + .'- weekly_restriction：周', + 'type' => 'string', + 'example' => 'daily_restriction', + ], + 'StartTimeOfDay' => [ + 'description' => '每天开始值班时间。', + 'type' => 'string', + 'example' => '09:00', + ], + 'EndTimeOfDay' => [ + 'description' => '每天结束值班时间。', + 'type' => 'string', + 'example' => '18:00', + ], + ], + ], + ], + ], + ], + ], + 'RenderedLayerEntries' => [ + 'description' => '查询时间范围内的排班人员。', + 'type' => 'array', + 'items' => [ + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => '排班人开始值班时间。', + 'type' => 'string', + 'example' => '2022-10-01', + ], + 'End' => [ + 'description' => '排班人结束值班时间。', + 'type' => 'string', + 'example' => '2022-10-30', + ], + 'SimpleContact' => [ + 'description' => '排班人信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '排班人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'description' => '排班人名称。', + 'type' => 'string', + 'example' => '员工1', + ], + ], + ], + ], + ], + ], + ], + 'RenderedSubstitudeEntries' => [ + 'description' => '查询时间范围内的替班人员。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => '替班人开始值班时间。'."\n" + ."\n", + 'type' => 'string', + 'example' => '2022-10-01', + ], + 'End' => [ + 'description' => '替班人结束值班时间。'."\n" + ."\n", + 'type' => 'string', + 'example' => '2022-10-30', + ], + 'SimpleContact' => [ + 'description' => '替班人信息。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '替班人ID。'."\n" + ."\n", + 'type' => 'integer', + 'format' => 'int64', + 'example' => '234', + ], + 'Name' => [ + 'description' => '替班人名称。', + 'type' => 'string', + 'example' => '员工2', + ], + ], + ], + ], + ], + ], + 'RenderedFinnalEntries' => [ + 'description' => '最终值班人员信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Start' => [ + 'description' => '值班人开始值班时间。', + 'type' => 'string', + 'example' => '2022-10-01', + ], + 'End' => [ + 'description' => '值班人结束值班时间。', + 'type' => 'string', + 'example' => '2022-10-30', + ], + 'SimpleContact' => [ + 'description' => '值班人信息。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'description' => '值班人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'description' => '值班人名称。', + 'type' => 'string', + 'example' => '员工1', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询排班策略信息', + ], + 'ListSilencePolicies' => [ + 'summary' => '调用ListSilencePolicies接口查询静默策略列表信息。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'title' => '静默策略名称', + 'description' => '静默策略名称。', + 'type' => 'string', + 'required' => false, + 'example' => 'silencepolicy_test', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '每页战术数目', + 'description' => '每页展示的数目。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => [ + 'title' => '是否查询详情信息', + 'description' => '是否查询静默策略详情。'."\n" + ."\n" + .'- `true`：查询。'."\n" + .'- `false`：不查询。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-beijing', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '78901766-3806-4E96-8E47-CFEF59E4****', + ], + 'PageBean' => [ + 'title' => '分页对象', + 'description' => '分页对象。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的静默策略总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询到的页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每页数目', + 'description' => '每页展示数目。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'SilencePolicies' => [ + 'title' => '静默策略列表', + 'description' => '静默策略列表。', + 'type' => 'array', + 'items' => [ + 'description' => '静默策略对象。', + 'type' => 'object', + 'properties' => [ + 'Id' => [ + 'title' => '静默策略ID', + 'description' => '静默策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Name' => [ + 'title' => '静默策略名称', + 'description' => '静默策略名称。', + 'type' => 'string', + 'example' => 'silencepolicy_test', + ], + 'MatchingRules' => [ + 'title' => '事件匹配规则列表', + 'description' => '分派规则列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分派规则对象。', + 'type' => 'object', + 'properties' => [ + 'MatchingConditions' => [ + 'title' => '匹配条件', + 'description' => '分派规则条件。', + 'type' => 'array', + 'items' => [ + 'description' => '分派规则条件对象。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'title' => '条件字段', + 'description' => '分派规则条件Key。', + 'type' => 'string', + 'example' => 'altertname', + ], + 'Value' => [ + 'title' => '条件字段值', + 'description' => '分派规则条件Value。', + 'type' => 'string', + 'example' => 'test', + ], + 'Operator' => [ + 'title' => '对应关系', + 'description' => '分派规则条件聚合方式。'."\n" + ."\n" + .'- `eq`：等于'."\n" + .'- `neq`：不等于'."\n" + .'- `in`：包含'."\n" + .'- `nin`：不包含'."\n" + .'- `re`：匹配正则'."\n" + .'- `nre`：正则不匹配', + 'type' => 'string', + 'example' => 'eq', + ], + ], + ], + ], + ], + ], + ], + 'State' => [ + 'title' => '静默策略是否启用，enable 启用，disable 停用', + 'description' => '静默策略是否启用，enable 启用，disable 停用', + 'type' => 'string', + 'example' => 'enable', + ], + 'TimeSlots' => [ + 'description' => '生效时间段', + 'type' => 'string', + 'example' => '[{"endTime":"00:00","endWeek":"7","startTime":"00:00","startWeek":"1"}]', + ], + 'TimePeriod' => [ + 'description' => '生效时间'."\n" + .'WEEK 每周'."\n" + .'DAY 每日', + 'type' => 'string', + 'example' => 'WEEK', + ], + 'EffectiveTimeType' => [ + 'description' => '生效类型'."\n" + .'持续生效：PERMANENT'."\n" + .'循环生效 ：CYCLE_EFFECT'."\n" + .'自定义时间段：CUSTOM_TIME', + 'type' => 'string', + 'example' => 'PERMANENT', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '静默策略列表信息', + ], + 'ListAlerts' => [ + 'summary' => '告警发送历史接口。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AlertName', + 'in' => 'query', + 'schema' => [ + 'title' => '告警名称', + 'description' => '告警名称。', + 'type' => 'string', + 'required' => false, + 'example' => '告警测试', + ], + ], + [ + 'name' => 'State', + 'in' => 'query', + 'schema' => [ + 'title' => '告警状态(0 - 待处理， 1 - 处理中， 2 - 已处理)', + 'description' => '告警状态：'."\n" + ."\n" + .'- 0：待处理'."\n" + .'- 1：处理中'."\n" + .'- 2：已处理', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2', + ], + ], + [ + 'name' => 'Severity', + 'in' => 'query', + 'schema' => [ + 'title' => '告警等级(P1~P6)', + 'description' => '告警等级。告警严重程度从P6、P5、P4、P3、P2、P1逐级上升。', + 'type' => 'string', + 'required' => false, + 'example' => 'P6', + ], + ], + [ + 'name' => 'DispatchRuleId', + 'in' => 'query', + 'schema' => [ + 'title' => '通知策略ID', + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'IntegrationType', + 'in' => 'query', + 'schema' => [ + 'title' => '集成类型', + 'description' => '集成类型。'."\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', + 'type' => 'string', + 'required' => false, + 'example' => 'ARMS_APP_MON', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', + 'description' => '查询告警发送历史记录的开始时间，时间格式为`YYYY-MM-DD HH:mm:ss`。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-10 00:00:00', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'title' => '查询告警发送历史记录的开始时间，时间格式：YYYY-MM-DD HH:mm:ss', + 'description' => '查询告警发送历史记录的结束时间，时间格式为`YYYY-MM-DD HH:mm:ss`。', + 'type' => 'string', + 'required' => false, + 'example' => '2021-12-22 23:59:59', + ], + ], + [ + 'name' => 'ShowEvents', + 'in' => 'query', + 'schema' => [ + 'title' => '默认不查事件，showEvents=true才查', + 'description' => '是否查询告警对应的事件。'."\n" + ."\n" + .'- `false`（默认）：不查询事件。'."\n" + .'- `true`：查询事件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'ShowActivities', + 'in' => 'query', + 'schema' => [ + 'title' => '默认不查活动记录，showActivities=true才查，只查最近3天的内容', + 'description' => '是否查询告警对应的活动记录。'."\n" + ."\n" + .'- `false`（默认）：不查询活动记录。'."\n" + .'- `true`：查询活动记录，仅查询近3天的活动记录。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'title' => '页数', + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Size', + 'in' => 'query', + 'schema' => [ + 'title' => '每页展示数目', + 'description' => '每页展示的告警数。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '20', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Owner', + 'in' => 'query', + 'schema' => [ + 'description' => '告警责任人，通知策略中配置的联系人通知对象。', + 'type' => 'string', + 'required' => false, + 'example' => '张三', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => '请求ID', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', + ], + 'PageBean' => [ + 'title' => '返回结构体', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Total' => [ + 'title' => '总数', + 'description' => '查询到的告警总数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Page' => [ + 'title' => '页数', + 'description' => '查询页数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'Size' => [ + 'title' => '每页展示数目', + 'description' => '每页展示的告警数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'ListAlerts' => [ + 'title' => '告警发送历史信息组', + 'description' => '告警发送历史信息组。', + 'type' => 'array', + 'items' => [ + 'description' => '返回对象结构体。', + 'type' => 'object', + 'properties' => [ + 'AlertName' => [ + 'title' => '告警名称', + 'description' => '告警名称。', + 'type' => 'string', + 'example' => '告警测试', + ], + 'Severity' => [ + 'title' => '告警等级(P1~P6)', + 'description' => '告警等级。告警严重程度从P6、P5、P4、P3、P2、P1逐级上升。', + 'type' => 'string', + 'example' => 'P6', + ], + 'State' => [ + 'title' => '告警状态(0 - 待处理， 1 - 处理中， 2 - 已处理)', + 'description' => '告警状态：'."\n" + ."\n" + .'- 0：待处理'."\n" + .'- 1：处理中'."\n" + .'- 2：已处理', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '0', + ], + 'DispatchRuleId' => [ + 'title' => '通知策略ID', + 'description' => '通知策略ID。', + 'type' => 'number', + 'format' => 'float', + 'example' => '12345', + ], + 'DispatchRuleName' => [ + 'title' => '通知策略名称', + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => '钉群通知', + ], + 'CreateTime' => [ + 'title' => '创建时间', + 'description' => '告警创建时间。', + 'type' => 'string', + 'example' => '2022-01-18 00:21:35', + ], + 'Activities' => [ + 'title' => '活动列表', + 'description' => '活动列表。', + 'type' => 'array', + 'items' => [ + 'description' => '活动对象。', + 'type' => 'object', + 'properties' => [ + 'Time' => [ + 'title' => '时间', + 'description' => '活动操作时间。', + 'type' => 'string', + 'example' => '2021-12-20 19:08:57', + ], + 'Type' => [ + 'title' => '活动类型', + 'description' => '活动类型。'."\n" + ."\n" + .'- 1：认领'."\n" + .'- 2：取消认领'."\n" + .'- 3：评论'."\n" + .'- 4：关闭'."\n" + .'- 5：通知', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'HandlerName' => [ + 'title' => '处理人名称', + 'description' => '处理人名称。', + 'type' => 'string', + 'example' => '运维A', + ], + 'Description' => [ + 'title' => '描述', + 'description' => '活动描述。', + 'type' => 'string', + 'example' => '[告警认领]认领了该告警', + ], + 'Content' => [ + 'title' => '通知内容', + 'description' => '告警通知内容。', + 'type' => 'string', + 'example' => '【通知策略: 钉群通知】 主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %', + ], + ], + ], + ], + 'AlertEvents' => [ + 'title' => '事件列表', + 'description' => '事件列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件对象。', + 'type' => 'object', + 'properties' => [ + 'AlertName' => [ + 'title' => '事件名称', + 'description' => '事件名称。', + 'type' => 'string', + 'example' => '测试触发的告警', + ], + 'Severity' => [ + 'title' => '事件等级', + 'description' => '事件等级。'."\n" + ."\n" + .'- critical'."\n" + .'- error'."\n" + .'- warning'."\n" + .'- info', + 'type' => 'string', + 'example' => 'warning', + ], + 'State' => [ + 'title' => '告警状态Active("Active"), * Inhibited("Inhibited"), * Silenced("Silenced"), * Resolved("Resolved")', + 'description' => '事件状态。'."\n" + ."\n" + .'- Active：未恢复'."\n" + .'- Silenced：静默'."\n" + .'- Resolved：已恢复', + 'type' => 'string', + 'example' => 'Active', + ], + 'StartTime' => [ + 'title' => '开始时间', + 'description' => '事件开始时间。', + 'type' => 'string', + 'example' => '2022-01-18 00:14:00', + ], + 'EndTime' => [ + 'title' => '结束时间', + 'description' => '事件结束时间。', + 'type' => 'string', + 'example' => '2022-01-19 17:10:31', + ], + 'ReceiveTime' => [ + 'title' => '事件接受时间', + 'description' => '事件创建时间。', + 'type' => 'string', + 'example' => '2022-01-19 17:05:42', + ], + 'IntegrationName' => [ + 'title' => '集成名称', + 'description' => '事件对应的集成名称。', + 'type' => 'string', + 'example' => 'ARMS', + ], + 'IntegrationType' => [ + 'title' => '集成类型', + 'description' => '事件对应的集成类型。'."\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', + 'type' => 'string', + 'example' => 'ARMS_APP_MON', + ], + 'GeneratorURL' => [ + 'title' => '事件地址', + 'description' => '事件地址。', + 'type' => 'string', + 'example' => 'http://arms.console.aliyun.com', + ], + 'Description' => [ + 'title' => '事件描述', + 'description' => '事件描述。', + 'type' => 'string', + 'example' => '主机监控 节点机IP: 10.76.XX.XX 节点机内存利用率最近1分钟求平均 >= 1.0 %, 当前值84.7454 %', + ], + 'Annotations' => [ + 'description' => '注释列表。', + 'type' => 'string', + 'example' => '{ "_aliyun_arms_alert_value":"4.0" "_aliyun_arms_alert_traceId":"ac10c43116421327442277073d5461-105075299"}', + ], + 'Labels' => [ + 'title' => '标签列表', + 'description' => '标签列表。', + 'type' => 'string', + 'example' => '{ "severity":"warning" "_aliyun_arms_alert_level":"ERROR" "_aliyun_arms_entropy":"0.30170457417889235"}', + ], + ], + ], + ], + 'AlertId' => [ + 'title' => '告警ID', + 'description' => '告警ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '2279', + ], + 'Solution' => [ + 'title' => '告警解决方案', + 'description' => '告警解决方案', + 'type' => 'string', + 'example' => '重启解决', + ], + 'Owner' => [ + 'description' => '告警负责人', + 'type' => 'string', + 'example' => '通知策略中配置的联系人通知对象', + ], + 'Handler' => [ + 'description' => '告警处理人', + 'type' => 'string', + 'example' => '认领、关闭告警的处理人', + ], + 'AcknowledgeTime' => [ + 'description' => '告警认领时长', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '告警从发生到认领之间的时长', + 'default' => '-1', + ], + 'RecoverTime' => [ + 'description' => '告警恢复时长', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '告警从发生到恢复之间的时长', + 'default' => '-1', + ], + 'NotifyRobots' => [ + 'description' => '及时通讯软件的联系人卡片列表。', + 'type' => 'string', + 'example' => '钉钉的名片。', + ], + 'Describe' => [ + 'description' => '事件运行的描述信息。', + 'type' => 'string', + 'example' => '[告警通知]通过[webhook]通知了xxx(成功）', + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '错误信息。', + 'type' => 'string', + 'example' => 'alert.manager.error.code.signature.invalid', + ], + ], + ], + ], + ], + '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' => '查询告警发送历史', + ], + 'BlockAlarmNotification' => [ + 'summary' => '屏蔽告警通知，屏蔽后告警在指定的时间范围内不再发生通知。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlarmId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警ID。'."\n" + ."\n" + .'获取告警ID，请参见[ListAlertEvents - 查询告警事件历史](~~2612346~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '133', + ], + ], + [ + 'name' => 'Timeout', + 'in' => 'query', + 'schema' => [ + 'description' => '从现在开始的多少秒内屏蔽告警通知，单位秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '180', + ], + ], + [ + 'name' => 'HandlerId', + 'in' => 'query', + 'schema' => [ + 'description' => '处理人员ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2044049', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', + ], + 'Result' => [ + 'description' => '是否操作成功。'."\n" + ."\n" + .'- `true`：操作成功。'."\n" + .'- `false`：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '屏蔽告警通知', + ], + 'ChangeAlarmSeverity' => [ + 'summary' => '修改告警等级。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlarmId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警ID。'."\n" + ."\n" + .'获取告警ID，请参见[ListAlertEvents - 查询告警事件历史](~~2612346~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '184723093', + ], + ], + [ + 'name' => 'Severity', + 'in' => 'query', + 'schema' => [ + 'description' => '告警等级。告警严重程度从P4、P3、P2、P1逐级上升。', + 'type' => 'string', + 'required' => true, + 'example' => 'P1', + 'enum' => [ + 'P1', + 'P2', + 'P3', + 'P4', + ], + ], + ], + [ + 'name' => 'HandlerId', + 'in' => 'query', + 'schema' => [ + 'description' => '处理人员ID', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2046076', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'F7781D4A-2818-41E7-B7BB-79D809E9****', + ], + 'Result' => [ + 'description' => '是否修改成功。'."\n" + ."\n" + .'- `true`：删除成功。'."\n" + .'- `false`：删除失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '附加消息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '修改告警等级', + ], + 'CloseAlarm' => [ + 'summary' => '关闭告警，请确保告警恢复后再关闭告警。如果告警一直处于触发状态，关闭告警后又会产生新的告警。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlarmId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警ID。'."\n" + ."\n" + .'获取告警ID，请参见[ListAlertEvents - 查询告警事件历史](~~2612346~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '184723093', + ], + ], + [ + 'name' => 'Solution', + 'in' => 'query', + 'schema' => [ + 'description' => '告警解决方案。', + 'type' => 'string', + 'required' => false, + 'example' => '重启修复', + ], + ], + [ + 'name' => 'HandlerId', + 'in' => 'query', + 'schema' => [ + 'description' => '处理人员ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2048065', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', + ], + 'Result' => [ + 'description' => '是否操作成功。'."\n" + ."\n" + .'- `true`：操作成功。'."\n" + .'- `false`：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '返回码。返回200代表成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '关闭告警', + ], + 'ClaimAlarm' => [ + 'summary' => '认领告警，配合升级策略使用。 在告警协同处理时可以，认领后表示该告警正在处理中。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlarmId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警ID。'."\n" + ."\n" + .'获取告警 ID，请参见[ListAlertEvents - 查询告警事件历史](~~2612346~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '184723093', + ], + ], + [ + 'name' => 'HandlerId', + 'in' => 'query', + 'schema' => [ + 'description' => '处理人员ID。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '2046076', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', + ], + 'Result' => [ + 'description' => '是否操作成功。'."\n" + ."\n" + .'- `true`：操作成功。'."\n" + .'- `false`：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功。'."\n" + ."\n" + .'`true`：操作成功。 '."\n" + ."\n" + .'`false`：操作失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '认领告警', + ], + 'CreatePrometheusAlertRule' => [ + 'summary' => '创建告警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'create', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlertName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Prometheus_Alert', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则类型。'."\n" + .'- 99：自定义告警'."\n" + .'- 101：Prometheus告警', + 'type' => 'string', + 'required' => false, + 'example' => '101', + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '通知类型。取值：'."\n" + ."\n" + .'- `ALERT_MANAGER`（默认）：通过告警运维中心通知。'."\n" + .'- `DISPATCH_RULE`：指定通知策略进行通知。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALERT_MANAGER', + ], + ], + [ + 'name' => 'DispatchRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '通知策略ID，当**NotifyType**指定为`DISPATCH_RULE`时必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10282', + ], + ], + [ + 'name' => 'Expression', + 'in' => 'query', + 'schema' => [ + 'description' => '告警表达式，需要使用PromQL语句。', + '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' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '10m', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'description' => '告警消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => '标签JSON串。需要设置标签的Name和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Value": "critical","Name": "severity"}]', + ], + ], + [ + 'name' => 'Annotations', + 'in' => 'query', + 'schema' => [ + 'description' => '注释JSON串。需要设置注释的Name和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Value": "xxx","Name": "description"}]', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签的值(value)。', + 'type' => 'string', + 'required' => false, + 'example' => 'value1', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'PrometheusAlertRule' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '告警规则启用状态。取值：'."\n" + ."\n" + .'- `1`：开启。'."\n" + .'- `0`：关闭。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => '告警规则类型。', + 'type' => 'string', + 'example' => 'Kubernetes组件告警', + ], + 'NotifyType' => [ + 'description' => '通知类型。取值：'."\n" + ."\n" + .'- `ALERT_MANAGER`：通过告警运维中心通知。'."\n" + .'- `DISPATCH_RULE`：指定通知策略进行通知。', + 'type' => 'string', + 'example' => 'ALERT_MANAGER', + ], + 'Expression' => [ + 'description' => '告警表达式。', + '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' => '告警消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + 'Duration' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'example' => '10m', + ], + 'DispatchRuleId' => [ + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10282', + ], + 'AlertName' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'Prometheus_Alert', + ], + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3888704', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + 'Labels' => [ + 'description' => '告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'severity', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'critical', + ], + ], + ], + ], + 'Annotations' => [ + 'description' => '告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则的注释。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '注释的名称。', + 'type' => 'string', + 'example' => 'message', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '创建告警规则', + 'description' => '> 建议使用[CreateOrUpdateAlertRule](~~411960~~)接口创建Prometheus告警规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeletePrometheusAlertRule' => [ + 'summary' => '删除Prometheus告警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'delete', + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则ID，您可以在ListPrometheusAlertRules API接口的返回数据中查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'minimum' => '0', + 'example' => '3888704', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus监控告警规则的集群ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '是否删除成功。取值：'."\n" + ."\n" + .'- `true`：删除成功'."\n" + .'- `false`：删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '详细信息', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '删除告警规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdatePrometheusAlertRule' => [ + 'summary' => '调用UpdatePrometheusAlertRule接口更新Prometheus报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AlertName', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Prometheus_Alert', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义告警规则类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'Kubernetes组件告警', + ], + ], + [ + 'name' => 'NotifyType', + 'in' => 'query', + 'schema' => [ + 'description' => '通知类型， 取值：'."\n" + ."\n" + .'- `ALERT_MANAGER`：通过告警运维中心通知。'."\n" + .'- `DISPATCH_RULE`：指定通知策略进行通知。', + 'type' => 'string', + 'required' => false, + 'example' => 'ALERT_MANAGER', + ], + ], + [ + 'name' => 'DispatchRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '通知策略ID，当**NotifyType**指定为`DISPATCH_RULE`时必填。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'example' => '10282', + ], + ], + [ + 'name' => 'Expression', + 'in' => 'query', + 'schema' => [ + 'description' => '告警表达式，需要使用PromQL语句。', + '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' => 'Duration', + 'in' => 'query', + 'schema' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'Message', + 'in' => 'query', + 'schema' => [ + 'description' => '告警消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + ], + [ + 'name' => 'Labels', + 'in' => 'query', + 'schema' => [ + 'description' => '标签JSON串。需要设置标签的Name和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Value": "critical","Name": "severity"}]', + ], + ], + [ + 'name' => 'Annotations', + 'in' => 'query', + 'schema' => [ + 'description' => '注释JSON串。需要设置注释的Name和Value。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"Value": "xxx","Name": "description"}]', + ], + ], + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则ID，您可以在ListPrometheusAlertRules API接口的返回数据中查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3888704', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键（key）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'PrometheusAlertRule' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '告警规则启用状态，取值：'."\n" + ."\n" + .'- `1`：开启'."\n" + .'- `0`：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => '告警规则类型。', + 'type' => 'string', + 'example' => 'Kubernetes组件告警', + ], + 'NotifyType' => [ + 'description' => '通知类型， 取值：'."\n" + ."\n" + .'- `ALERT_MANAGER`：通过报警运维中心通知。'."\n" + .'- `DISPATCH_RULE`：指定通知策略进行通知。', + 'type' => 'string', + 'example' => 'ALERT_MANAGER', + ], + 'Expression' => [ + 'description' => '告警表达式。', + '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' => '告警通知消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + 'Duration' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'example' => '1', + ], + 'DispatchRuleId' => [ + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10282', + ], + 'AlertName' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'Prometheus_Alert', + ], + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3888704', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + 'Labels' => [ + 'description' => '告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'severity', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'critical', + ], + ], + ], + ], + 'Annotations' => [ + 'description' => '告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '注释的名称。', + 'type' => 'string', + 'example' => 'message', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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":""}]', + 'title' => ' 更新告警规则', + 'description' => 'UpdatePrometheusAlertRule接口已不再维护，请使用CreateOrUpdateAlertRule接口创建或修改告警规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribePrometheusAlertRule' => [ + 'summary' => '查看Prometheus告警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则ID，您可以在ListPrometheusAlertRules API接口的返回数据中查看。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '3888704', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Prometheus实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cc7a37ee31aea4ed1a059eff8034b****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'PrometheusAlertRule' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '告警规则启用状态，取值：'."\n" + ."\n" + .'- `1`：开启'."\n" + .'- `0`：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => '告警规则类型。', + 'type' => 'string', + 'example' => 'Kubernetes组件告警', + ], + 'NotifyType' => [ + 'description' => '通知类型， 取值：'."\n" + ."\n" + .'- `ALERT_MANAGER`：通过告警运维中心通知。'."\n" + .'- `DISPATCH_RULE`：指定通知策略进行通知。', + 'type' => 'string', + 'example' => 'ALERT_MANAGER', + ], + 'Expression' => [ + 'description' => '告警表达式。', + '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' => '告警通知消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + 'Duration' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'example' => '1m', + ], + 'DispatchRuleId' => [ + 'description' => '通知策略ID，当**NotifyType**指定为`DISPATCH_RULE`时显示此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10282', + ], + 'AlertName' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'Prometheus_Alert', + ], + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3888704', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + 'Labels' => [ + 'description' => '告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'severity', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'critical', + ], + ], + ], + ], + 'Annotations' => [ + 'description' => '告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '注释的名称。', + 'type' => 'string', + 'example' => 'message', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。说明 200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Success' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'True', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + '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' => '查看告警规则', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPrometheusAlertRules' => [ + 'summary' => '查看Prometheus告警规则列表。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'list', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Prometheus_Alert', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则类型。', + 'type' => 'string', + 'required' => false, + 'example' => '自定义', + ], + ], + [ + 'name' => 'Status', + 'in' => 'query', + 'schema' => [ + 'description' => '告警规则启用状态，取值：'."\n" + ."\n" + .'- `1`：开启'."\n" + .'- `0`：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'MatchExpressions', + 'in' => 'query', + 'schema' => [ + 'description' => '标签匹配条件的JSON串。关于此字段的详细说明参见下文**关于参数MatchExpressions的补充说明**。', + 'type' => 'string', + 'required' => false, + 'example' => '[{"key":"severity","value":"critical","operator":"re"}]', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签的键(key)。', + 'type' => 'string', + 'required' => false, + 'example' => 'owner', + ], + 'Value' => [ + 'description' => '标签的值（value）。', + 'type' => 'string', + 'required' => false, + 'example' => 'zhangsan', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'PrometheusAlertRules' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '告警规则启用状态，取值：'."\n" + ."\n" + .'- `1`：开启'."\n" + .'- `0`：关闭', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Type' => [ + 'description' => '告警规则类型。', + 'type' => 'string', + 'example' => '自定义', + ], + 'NotifyType' => [ + 'description' => '通知类型， 取值：'."\n" + ."\n" + .'- `ALERT_MANAGER`：通过报警运维中心通知。'."\n" + .'- `DISPATCH_RULE`：指定通知策略进行通知。', + 'type' => 'string', + 'example' => 'ALERT_MANAGER', + ], + 'Expression' => [ + 'description' => '告警表达式。', + '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' => '告警通知消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + 'Duration' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'example' => '1m', + ], + 'DispatchRuleId' => [ + 'description' => '通知策略ID，当**NotifyType**指定为`DISPATCH_RULE`时显示此参数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10282', + ], + 'AlertName' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => 'Prometheus_Alert', + ], + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '3888704', + ], + 'ClusterId' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + 'Labels' => [ + 'description' => '告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则的标签。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'severity', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'critical', + ], + ], + ], + ], + 'Annotations' => [ + 'description' => '告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'description' => '告警规则的注释。', + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '注释的名称。', + 'type' => 'string', + 'example' => 'message', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'example' => '${{$labels.pod_name}}CPU使用率大于80%，当前值{{$value}}%', + ], + ], + ], + ], + 'Tags' => [ + 'description' => '标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => 'Tag的主键。', + 'type' => 'string', + 'example' => 'key', + ], + 'Value' => [ + 'description' => 'Tag的值。', + 'type' => 'string', + 'example' => 'value', + ], + ], + ], + ], + ], + ], + ], + 'Code' => [ + 'description' => '状态码。200为成功，其他状态码为异常。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'Success' => [ + 'description' => '调用是否成功。', + 'type' => 'boolean', + 'example' => 'True', + ], + ], + ], + ], + ], + '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":"<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' => '查看告警规则列表', + 'requestParamsDescription' => '## 关于参数**MatchExpressions**的补充说明'."\n" + .'**JSON串示例及说明**'."\n" + .'```'."\n" + .'['."\n" + .'{'."\n" + .' "key":"severity", // 标签的Key。'."\n" + .' "value":"critical", // 标签的Value。'."\n" + .' "operator":"re" // eq：等于；re：匹配正则。'."\n" + .'}'."\n" + .']'."\n" + .'```', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListPrometheusAlertTemplates' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ClusterId', + 'in' => 'query', + 'schema' => [ + 'description' => '集群ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'c0bad479465464e1d8c1e641b0afb****', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9FEA6D00-317F-45E3-9004-7FB8B0B7****', + ], + 'PrometheusAlertTemplates' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '告警规则类型。', + 'type' => 'string', + 'example' => '节点', + ], + 'Description' => [ + 'description' => '告警消息，支持按照{{$labels.xxx}}格式来引用标签。', + 'type' => 'string', + 'example' => '节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%', + ], + 'Expression' => [ + 'description' => '告警表达式。', + 'type' => 'string', + 'example' => 'node_memory_MemAvailable_bytes / node_memory_MemTotal_bytes * 100 < 10', + ], + 'Version' => [ + 'description' => '告警规则版本。', + 'type' => 'string', + 'example' => '1.0', + ], + 'Duration' => [ + 'description' => '持续时间，范围在1m~1440m，单位为分钟。', + 'type' => 'string', + 'example' => '1m', + ], + 'AlertName' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => '节点内存可用率不足10%', + ], + 'Labels' => [ + 'description' => '告警规则的标签。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '标签的名称。', + 'type' => 'string', + 'example' => 'severity', + ], + 'Value' => [ + 'description' => '标签的值。', + 'type' => 'string', + 'example' => 'warning', + ], + ], + ], + ], + 'Annotations' => [ + 'description' => '告警规则的注释。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '注释的名称。', + 'type' => 'string', + 'example' => 'message', + ], + 'Value' => [ + 'description' => '注释的值。', + 'type' => 'string', + 'example' => '节点 {{ $labels.instance }} 可用内存不足10%，当前可用内存 {{ $value }}%', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查看告警模板列表', + 'summary' => '调用ListPrometheusAlertTemplates接口查看Prometheus告警模板列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAlertContact' => [ + 'summary' => '创建报警联系人。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'JohnDoe', + ], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人手机号码。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1381111****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人邮箱地址。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'DingRobotWebhookUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">钉钉机器人Webhook URL，获取方式请参见[设置钉钉机器人报警](https://help.aliyun.com/document_detail/106247.html)。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。</props>'."\n" + .'<props="intl">钉钉机器人Webhook URL，获取方式请参见[设置钉钉机器人报警](https://www.alibabacloud.com/help/zh/doc-detail/106247.htm)。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。</props>'."\n" + .'> 钉钉机器人安全设置中的自定义关键词请填写`报警`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', + ], + ], + [ + 'name' => 'SystemNoc', + 'in' => 'query', + 'schema' => [ + 'description' => '是否接收系统通知：'."\n" + ."\n" + .'- `true`：接收系统通知'."\n" + .'- `false`：不接收系统通知', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。始终填写`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-aek2eq4peca****', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => [ + 'description' => '报警联系人ID。', + 'type' => 'string', + 'example' => '102**', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'E9C9DA3D-10FE-472E-9EEF-2D0A3E41****', + ], + ], + ], + ], + ], + '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' => '创建报警联系人', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateContact接口创建或修改联系人。', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateWebhook' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义联系人名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'Webhook告警', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求方法。'."\n" + ."\n" + .'- `Get`'."\n" + .'- `Post`', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'Post', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '**Method**的请求方法URL。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******', + ], + ], + [ + 'name' => 'HttpParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"name":"mike"}]', + ], + ], + [ + 'name' => 'HttpHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Content-Type":"application/json"}]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'description' => '告警触发时发送的通知模板，当**Method**设置为**Post**时必填，可使用$content占位符输出通知内容，不可超过500个字符。', + '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 }}" }', + ], + ], + [ + 'name' => 'RecoverBody', + 'in' => 'query', + 'schema' => [ + 'description' => '告警恢复时发送的通知模板，当**Method**设置为**Post**时必填，可使用$content占位符输出通知内容，不可超过500个字符。', + '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' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ContactId' => [ + 'description' => 'Webhook告警联系人ID。', + 'type' => 'string', + 'example' => '48716', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + ], + ], + ], + ], + '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' => '创建Webhook告警联系人', + 'summary' => '调用CreateWebhook接口创建Webhook告警联系人。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateWebhookContact接口创建或修改Webhook告警联系人。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateAlertContactGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44428', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人分组名称。'."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要包含在报警联系人分组内的联系人ID。多个联系人ID以空格分隔。可调用SearchAlertContact接口来查询联系人ID，详情请参见[SearchAlertContact](~~130703~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '12* 23* 34*', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认情况下请填写`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'ContactGroupId' => [ + 'description' => '报警联系人分组ID。', + 'type' => 'string', + 'example' => '446*', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '70675725-8F11-4817-8106-CFE0AD71****', + ], + ], + ], + ], + ], + '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' => '创建报警联系人分组', + 'summary' => '调用CreateAlertContactGroup接口创建报警联系人分组。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateContactGroup接口创建或修改告警联系人组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'CreateDispatchRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44431', + 'abilityTreeNodes' => [ + 'FEATUREarmsVBCGEE', + ], + ], + 'parameters' => [ + [ + 'name' => 'DispatchRule', + 'in' => 'query', + 'schema' => [ + 'description' => '分派条件的配置JSON串。关于此字段的详细说明参见下文**关于参数DispatchRule的补充说明**。'."\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"] }, ], }', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'DispatchRuleId' => [ + 'description' => '分派策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10413', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + ], + ], + ], + ], + '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' => '创建分派策略', + 'summary' => '创建分派策略。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateNotificationPolicy接口创建或修改通知策略。', + 'requestParamsDescription' => '## 关于参数**DispatchRule**的补充说明'."\n" + .'**JSON串示例及说明**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "system": false, //分派条件是否可编辑。true：不可编辑；false：可编辑。'."\n" + .' "ruleid": 10282, //分派规则ID。'."\n" + .' "name": "Prometheus Alert", //分派策略名称。'."\n" + .' "labelMatchExpressionGrid": {'."\n" + .' "labelMatchExpressionGroups": [ //设置分派条件。'."\n" + .' {'."\n" + .' "labelMatchExpressions": ['."\n" + .' {'."\n" + .' "key": "_aliyun_arms_involvedObject_kind", //分派条件标签，详见下一节。'."\n" + .' "value": "app", //标签取值。'."\n" + .' "operator": "eq" //eq：等于；re：匹配正则。'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dispatchType": "CREATE_ALERT/DISCARD_ALERT", //告警处理方式。CREATE_ALERT：就是生成报警；DISCARD_ALERT：丢弃报警事件，即不告警。'."\n" + .' "isRecover": true, //是否发送恢复的告警。true：发送；false：不发送。'."\n" + .' "groupRules": [ //设置事件分组。'."\n" + .' {'."\n" + .' "groupId": 1, //分组ID。'."\n" + .' "groupingFields": [ //指定相同字段内容的事件分到一个组：设置分组字段，相同字段的告警内容会分别通过独立信息发送给处理人。'."\n" + .' "alertname"'."\n" + .' ],'."\n" + .' "groupWait": 10, //分组等待时间：收到第一个告警后会等待设置的时间，等待分组时间后收到的所有告警会以一条信息发送给处理人。'."\n" + .' "groupInterval": 15, //分组间隔时间：在重复告警静默时间内，如果有新告警产生，等待设置的时间后就会直接发送新的告警信息。'."\n" + .' "repeatInterval": 20 //重复告警静默时间：所有告警会以设置的时间间隔循环发送告警信息直至告警消失。'."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyRules": [ //设置通知规则。'."\n" + .' {'."\n" + .' "notifyObjects": ['."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT", //ARMS_CONTACT：联系人；ARMS_CONTACT_GROUP：联系人组。'."\n" + .' "name": "JohnDoe", //联系人或联系人组的名称。'."\n" + .' "notifyObjectId": 1 //联系人或联系人组的ID。'."\n" + .' },'."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT_GROUP",'."\n" + .' "name": "JohnDoe_group",'."\n" + .' "notifyObjectId": 2'."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyChannels":["dingTalk","wechat","webhook","email"] //通知方式：dingTalk（ 钉钉）、sms（短信）、webhook、email（邮件）、wechat（微信）。'."\n" + .' },'."\n" + .' ],'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + ."\n" + .'**分派标签取值枚举**'."\n" + ."\n" + .'- `_aliyun_arms_userid`：用户ID'."\n" + .'- `_aliyun_arms_involvedObject_kind`：关联对象类型'."\n" + .'- `_aliyun_arms_involvedObject_id`：关联对象ID'."\n" + .'- `_aliyun_arms_involvedObject_name`：关联对象名称 '."\n" + .'- `_aliyun_arms_alert_name`：告警名称'."\n" + .'- `_aliyun_arms_alert_rule_id`：告警规则对应的ID'."\n" + .'- `_aliyun_arms_alert_type`：告警类型 '."\n" + .'- `_aliyun_arms_alert_level`：告警等级 '."\n" + ."\n" + .' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListActivatedAlerts' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44476', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'Filter', + 'in' => 'query', + 'schema' => [ + 'description' => '筛选条件，格式为`{"key":"value"}`。需要设置筛选条件的`key`和`value`。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '{"alertname":"容器CPU使用率大于80%"}', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。'."\n" + ."\n", + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou ', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的页码。默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的每页项目数量。默认为`10`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'docRequired' => true, + 'example' => '10', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'BDB74B8F-4123-482A-ABB7-7F440349****', + ], + 'Page' => [ + 'description' => '返回结构体。'."\n" + ."\n", + 'type' => 'object', + 'properties' => [ + 'PageSize' => [ + 'description' => '查询结果分页的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'Total' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Page' => [ + 'description' => '查询结果分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'Alerts' => [ + 'description' => '告警信息。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '告警状态。取值：'."\n" + .'- `Active`：未恢复。'."\n" + .'- `Inhibited`：抑制。'."\n" + .'- `Silenced`：静默。'."\n" + .'- `Resolved`：已恢复。', + 'type' => 'string', + 'example' => 'Active', + ], + 'Severity' => [ + 'description' => '告警等级。取值：'."\n" + ."\n" + .'- `critical`：严重。'."\n" + .'- `error`：错误。'."\n" + .'- `warn`：警告。'."\n" + .'- `page`：通知。', + 'type' => 'string', + 'example' => 'critical', + ], + 'IntegrationName' => [ + 'description' => '告警关联对象名称。', + 'type' => 'string', + 'example' => 'testphp2', + ], + 'CreateTime' => [ + 'description' => '告警规则创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1616466300000', + ], + 'Message' => [ + 'description' => '告警描述信息。', + 'type' => 'string', + 'example' => '报警名称：PodRestart_testphp2，\\n Pod night-test-group-1-1-5f5d6f4d84-pszns is restart, Value: 133.33%, 1.33%', + ], + 'AlertType' => [ + 'description' => '告警类型。', + 'type' => 'string', + 'example' => 'ARMS-Prometheus监控', + ], + 'InvolvedObjectName' => [ + 'description' => '告警来源集成的名称。', + 'type' => 'string', + 'example' => '测试集成-prometheus', + ], + 'AlertName' => [ + 'description' => '告警规则名称。', + 'type' => 'string', + 'example' => '容器CPU使用率大于80%', + ], + 'Count' => [ + 'description' => '告警事件接受次数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '598', + ], + 'ExpandFields' => [ + 'description' => '扩展字段（标签），标签来源包括：'."\n" + ."\n" + .'- 报警规则表达式指标中携带的标签。'."\n" + .'- 通过报警规则创建的标签。'."\n" + .'- ARMS系统自带的默认标签。', + '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"', + ], + 'EndsAt' => [ + 'description' => '告警结束时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1616502540000', + ], + 'InvolvedObjectKind' => [ + 'description' => '告警关联对象类型。', + 'type' => 'string', + 'example' => 'cluster', + ], + 'IntegrationType' => [ + 'description' => '告警来源集成的类型。', + 'type' => 'string', + 'example' => 'PROMETHEUS', + ], + 'StartsAt' => [ + 'description' => '告警开始时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1616466300000', + ], + 'AlertId' => [ + 'description' => '告警规则ID。', + 'type' => 'string', + 'example' => '3888704', + ], + 'DispatchRules' => [ + 'description' => '通知策略。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RuleId' => [ + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '7021', + ], + 'RuleName' => [ + 'description' => '通知策略名称。', + 'type' => 'string', + 'example' => '容器CPU使用率大于80%的通知策略', + ], + ], + ], + ], + ], + ], + ], + ], + ], + 'Message' => [ + 'description' => '调用失败给出的错误消息', + 'type' => 'string', + 'example' => 'CurrentPage is mandatory for this action.', + ], + ], + ], + ], + ], + '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' => '查询已经触发的告警列表', + 'summary' => '调用ListActivatedAlerts接口查询已经触发的告警列表。', + 'description' => '当前接口已不再维护，请使用新版告警管理的ListAlerts接口查询告警发送历史。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ImportAppAlertRules' => [ + 'summary' => '调用ImportAppAlertRules接口创建应用报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'TemplateAlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警模板ID。**TemplateAlertId**和**TemplageAlertConfig**必须至少填写一个。如果两个参数都填写，则**TemplateAlertId**优先。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '324324234', + ], + ], + [ + 'name' => 'Pids', + 'in' => 'query', + 'schema' => [ + 'description' => '常见报警规则关联的ARMS应用ID（即PID），格式为JsonArrayListStr。'."\n" + ."\n" + .'在**ARMS控制台**的**应用监控**>**应用列表**页面单击目标应用名称。此时浏览器地址栏中的URL即包含应用的pid，格式为pid=xxx。由于浏览器进行了编码，因此需要对pid稍作修改。例如，如果URL中包含的pid为xxx%4074xxx，则需要将%40替换为@，即：xxx@74xxx。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '["atc889zkcf@d8deedfa9bfxxxx", "acd129bfcf@d5daebfa6cdxxxx"]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '应用报警规则关联的应用所属地域的ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人分组ID，格式为JSONArray。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[123, 234]', + ], + ], + [ + 'name' => 'IsAutoStart', + 'in' => 'query', + 'schema' => [ + 'description' => '生成报警规则后是否自动启动报警规则。默认为`false`。'."\n" + ."\n" + .'- `true`：自动启动报警规则'."\n" + .'- `false`：不自动启动报警规则', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TemplageAlertConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'ARMS报警规则的配置JSON串。**TemplateAlertId**和**TemplageAlertConfig**必须至少填写一个。如果两个参数都填写，则**TemplateAlertId**优先。关于此字段的详细说明参见下文**关于参数TemplageAlertConfig的补充说明**。'."\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" } ]', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'type', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'prod', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '报警规则ID', + 'type' => 'string', + 'example' => '[12174**]', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + ], + ], + ], + ], + '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' => '创建应用报警规则', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateAlertRule接口创建或修改告警规则。'."\n" + .'> **ImportAppAlertRules**接口仅适合于导入应用监控和前端监控报警规则，包括系统自动生成的应用监控和前端监控报警规则。该接口不适用于导入自定义监控报警规则、Prometheus监控报警规则、默认紧急报警规则等。', + 'requestParamsDescription' => '## 关于参数**TemplageAlertConfig**的补充说明'."\n" + ."\n" + .'**报警模板JSON串示例及说明**'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + ."\n" + .' "contactGroupIds": "381", // 报警通知发送的联系人分组ID，以半角逗号（,）分隔。报警模板中忽略，导入时会映射对应值。'."\n" + .' "alertType": 5, // 可选值为4和5。4表示前端监控报警，5表示应用监控报警。'."\n" + .' "alarmContext": { // 报警通知内容模板。'."\n" + .' "subTitle": "",'."\n" + .' "content": "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！"'."\n" + .' },'."\n" + .' "alertLevel": "WARN", // 报警等级：FATAL、ERROR、WARN。'."\n" + .' "metricParam": {'."\n" + .' "appId": "70901", // 报警关联的应用AppId。模板报警配置中可随意填写，导入时会映射对应值。'."\n" + .' "pid": "atc889zkcf@d8deedfa9bf****", // 报警关联的应用Pid。模板报警配置中可随意填写，导入时会映射对应值。'."\n" + .' "type": "TXN", // 报警指标类型，详见下一节。'."\n" + .' "dimensions": [ // 报警关联的维度，详见下一节。'."\n" + .' {'."\n" + .' "type": "STATIC",'."\n" + .' "value": "\\\\/hello_test_api_address\\\\/test1",'."\n" + .' "key": "rpc"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "alertWay": [ // 报警通知发送方式：SMS（开启短信通知）、MAIL（开启邮件通知）、DING_ROBOT（开启钉钉机器人通知）。'."\n" + .' "SMS",'."\n" + .' "MAIL",'."\n" + .' "DING_ROBOT"'."\n" + .' ],'."\n" + .' "alertRule": {'."\n" + .' "rules": [ // 报警判断规则列表'."\n" + .' {'."\n" + .' "measure": "appstat.txn.rt", // 报警规则请求指标，详见下一节。'."\n" + .' "alias": "入口调用响应时间_ms", // 报警规则请求指标展示字段，报警模板无需填此字段。'."\n" + .' "aggregates": "AVG", // 数据请求后聚合算子。AVG为取平均，SUM为取和，MIN为取最小值，MAX为取最大值。'."\n" + .' "nValue": 1, // 报警规则每分钟轮询请求几分钟的数据。'."\n" + .' "value": 1, // 报警规则判断阈值。'."\n" + .' "operator": "CURRENT_GTE" // CURRENT_GTE：大于或等于；CURRENT_LTE：小于或等于；PREVIOUS_UP：环比上升；PREVIOUS_DOWN：环比下降；HOH_UP：与上小时同比上升；HOH_DOWN：与上小时同比下降；DOD_UP：与昨日同比上升百分比；DOD_DOWN：与昨日同比下降百分比。'."\n" + .' }'."\n" + .' ],'."\n" + .' "operator": "|" // 表示多个判断条件的组合方式。&为与逻辑，|为或逻辑。'."\n" + .' },'."\n" + .' "title": "报警模板报警名", // 模板报警名称。导入后，会生成新报警名称“{title}-应用名”。'."\n" + .' "config": "{\\"continuous\\":false,\\"dataRevision\\":2,\\"ownerId\\":\\"123412341234\\"}", // continuous为true表示连续报警，continuous为false表示以24小时为静默期的静默报警策略。dataRevision字段为数据修订策略，0表示补零，1表示补1，2表示空值，即不处理。'."\n" + .' "notice": { // unix timstamp ms时间戳，noticeStartTime与noticeEndTime时间戳表示通知时间范围，startTime与endTime表示报警生效时间范围，timestamp转换为时间戳表示当天时间点，如1565964097071对应2019-08-16 22:01:37。'."\n" + .' "noticeStartTime": 1480521600000,'."\n" + .' "startTime": 1480521600000,'."\n" + .' "endTime": 1480607940000,'."\n" + .' "noticeEndTime": 1480607940000'."\n" + .' },'."\n" + .' "status": "NON" // 报警当前启动状态。报警模板中忽略此字段，导入时会映射对应值。'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'**关于报警模板中Measure、Dimension、metricParam.type的说明**'."\n" + ."\n" + .'每个报警属于一个类型（type），由**metricParam.type**字段控制。每类报警都能设置一种维度（Dimension）作为筛选条件。每类报警都可以配置多个报警规则（alertRule），每个**alertRule**可以配置多个属于此类型的数据请求指标进行计算。'."\n" + ."\n" + .'**Dimensions.type**包含以下可选值：'."\n" + .'- `STATIC`： 固定匹配此维度值需要填**dimensions.value**。'."\n" + .'- `ALL`：遍历所有维度值，按此接口所有接口名的指标依次判断，哪个接口触发阈值引起报警，就会在报警内容中体现该接口名，此时不需要填**dimensions.value**。'."\n" + .'- `DISABLE`：聚合所有维度值为一个值（求和），此时不需要填**dimensions.value**。'."\n" + ."\n" + .'**报警指标取值枚举**'."\n" + ."\n" + .'- 报警类型（metricParam.type）：TXN（应用提供服务统计）'."\n" + .' - 此类报警维度（dimensions.key）：'."\n" + .' - rpc：接口名称'."\n" + .' - rpcType：接口调用类型，如HTTP、DUBBO'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.txn.rt：入口调用响应时间（毫秒）'."\n" + .' - appstat.txn.count：入口调用次数'."\n" + .' - appstat.txn.errcount：入口调用错误次数'."\n" + .'- 报警类型（metricParam.type）：TXN_TYPE（应用依赖服务调用统计）'."\n" + .' - 此类报警维度（dimensions.key）：rpcType（接口调用类型，如HTTP、DUBBO）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.outcall.rt：应用依赖服务调用响应时间（毫秒）'."\n" + .' - appstat.outcall.count：应用依赖服务调用次数'."\n" + .' - appstat.outcall.error：应用依赖服务调用错误数'."\n" + .'- 报警类型（metricParam.type）：DB（数据库指标）'."\n" + .' - 此类报警维度（dimensions.key）：endpoint（数据库名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.database.rt：数据库调用响应时间（毫秒）'."\n" + .' - appstat.database.count：数据库调用次数'."\n" + .' - appstat.database.errcount：数据库调用错误次数'."\n" + .'- 报警类型（metricParam.type）：JVM（JVM监控）'."\n" + .' - 此类报警维度（dimensions.key）：rootIp（机器IP地址）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）： '."\n" + .' - appstat.jvm.heap_used：JVM堆内总内存量（字节）'."\n" + .' - appstat.jvm.GcPsScavengeCount：JVM垃圾回收次数'."\n" + .' - appstat.jvm.GcPsMarkSweepCount：JVM标记清除次数'."\n" + .' - appstat.jvm.GcG1OldGenCount：JVM_Old区G1GC次数'."\n" + .' - appstat.jvm.GcG1YoungGenCount：JVM_Young区G1GC次数'."\n" + .' - appstat.jvm.gc.YoungGcCountInstant：JVM_YoungGC次数'."\n" + .' - appstat.jvm.gc.OldGcCountInstant：JVM_FullGC次数'."\n" + .' - appstat.jvm.gc.YoungGcTimeInstant：JVM_YoungGC耗时（毫秒）'."\n" + .' - appstat.jvm.gc.OldGcTimeInstant：JVM_FullGC耗时（毫秒）'."\n" + .' - appstat.jvm.ThreadCount：JVM_线程总数'."\n" + .' - appstat.jvm.non_heap_used：JVM非堆总使用内存量（字节）'."\n" + .' - appstat.jvm.non_heap_max：JVM非堆内存最大值（字节）'."\n" + .' - appstat.jvm.non_heap_init：JVM非堆内存初始值（字节）'."\n" + .' - appstat.jvm.non_heap_committed：JVM非堆内存提交值（字节）'."\n" + .'- 报警类型（metricParam.type）：HOST（主机监控）'."\n" + .' - 此类报警维度（dimensions.key）：rootIp（机器IP地址）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.jvm.SystemCpuUser：节点机用户使用CPU（百分比）'."\n" + .' - appstat.jvm.SystemMemFree：节点机空闲内存（字节）'."\n" + .' - appstat.jvm.SystemDiskFree：节点机空闲磁盘（字节）'."\n" + .' - appstat.jvm.SystemNetInErrs：节点机接收错误报文数'."\n" + .' - appstat.jvm.SystemNetOutErrs：节点机发送错误报文数'."\n" + .' - appstat.jvm.SystemLoad：节点机系统负载'."\n" + .'- 报警类型（metricParam.type）：EXCEPTION（异常接口调用）'."\n" + .' - 此类报警维度（dimensions.key）：rpc（接口名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.exception.rt：应用异常接口调用响应时间（毫秒）'."\n" + .' - appstat.exception.count：应用异常接口调用次数', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAlertRules' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AlertIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要删除的报警规则ID列表。格式为JSONArray，例如：`[123, 234]`。可调用SearchAlertRules接口获取报警规则ID（对应返回参数中的`Id`），详情请参见[SearchAlertRules](~~175825~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '[123, 234]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '删除报警规则是否成功。'."\n" + ."\n" + .'- `true`：删除成功'."\n" + .'- `false`：删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + ], + ], + ], + ], + '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' => '删除报警规则', + 'summary' => '调用DeleteAlertRules接口删除报警规则。', + 'description' => '当前接口已不再维护，请使用新版告警管理的DeleteAlertRule接口删除告警规则。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAlertContact' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44436', + 'abilityTreeNodes' => [ + 'FEATUREarmsK5DKZM', + ], + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的报警联系人的ID。可调用SearchAlertContact接口来查询联系人ID，详情请参见[SearchAlertContact](~~130703~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '删除联系人是否成功。'."\n" + ."\n" + .'- `true`：删除成功'."\n" + .'- `false`：删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + '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' => '删除报警联系人', + 'summary' => '调用DeleteAlertContact接口删除报警联系人。', + 'description' => '当前接口已不再维护，请使用新版告警管理的DeleteContact接口删除告警联系人。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteAlertContactGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要删除的联系人分组的ID。可调用SearchAlertContactGroup接口来查询联系人分组ID，详情请参见[SearchAlertContactGroup](~~130671~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '删除报警联系人分组是否成功。'."\n" + ."\n" + .'- `true`：删除成功'."\n" + .'- `false`：删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'C21AB7CF-B7AF-410F-BD61-82D1567F****', + ], + ], + ], + ], + ], + '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' => '删除报警联系人分组', + 'summary' => '调用DeleteAlertContactGroup接口删除报警联系人分组。', + 'description' => '当前接口已不再维护，请使用新版告警管理的DeleteContactGroup接口删除告警联系人组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DeleteDispatchRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44440', + 'abilityTreeNodes' => [ + 'FEATUREarmsVBCGEE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '分派策略ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '12345', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '是否删除成功。'."\n" + ."\n" + .'- `true`删除成功'."\n" + .'- `false`删除失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + ], + ], + ], + ], + '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' => '删除指定ID的通知策略', + 'summary' => '加快删除指定ID的告警通知策略。', + 'description' => '当前接口已不再维护，请使用新版告警管理的DeleteNotificationPolicy接口删除指定ID的通知策略。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateWebhook' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '自定义联系人名称。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'Webhook告警', + ], + ], + [ + 'name' => 'Method', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求方法。'."\n" + ."\n" + .'- `Get`'."\n" + .'- `Post`', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'Post', + ], + ], + [ + 'name' => 'Url', + 'in' => 'query', + 'schema' => [ + 'description' => '**Method**的请求方法URL。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=e1a049121ddbfce1ca963d115ef88cc7219583c4fb79fe6e398fbfb688******', + ], + ], + [ + 'name' => 'HttpParams', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"name":"mike"}]', + ], + ], + [ + 'name' => 'HttpHeaders', + 'in' => 'query', + 'schema' => [ + 'description' => 'HTTP请求头。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[{"Content-Type":"application/json"}]', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => 'Webhook告警联系人ID。您可以调用**SearchAlertContact**接口获取。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775807', + 'minimum' => '0', + 'example' => '48716', + ], + ], + [ + 'name' => 'Body', + 'in' => 'query', + 'schema' => [ + 'description' => '告警触发时发送的通知模板，当**Method**设置为**Post**时必填，可使用$content占位符输出通知内容，不可超过500个字符。', + '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 }}" }', + ], + ], + [ + 'name' => 'RecoverBody', + 'in' => 'query', + 'schema' => [ + 'description' => '告警恢复时发送的通知模板，当**Method**设置为**Post**时必填，可使用$content占位符输出通知内容，不可超过500个字符。', + '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' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '请求结果。'."\n" + ."\n" + .'- `true`：修改成功。'."\n" + .'- `false`：修改失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '16AF921B-8187-489F-9913-43C808B4****', + ], + ], + ], + ], + ], + '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' => '更新Webhook联系人', + 'summary' => '调用UpdateWebhook接口修改Webhook告警联系人信息。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateWebhookContact接口创建或修改Webhook告警联系人。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAlertContact' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '将报警联系人名称改为此名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'John Doe', + ], + ], + [ + 'name' => 'PhoneNum', + 'in' => 'query', + 'schema' => [ + 'description' => '将报警联系人的手机号码修改为此值。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。'."\n" + ."\n" + .'> 如果此参数为空，则表示删除报警联系人的该参数。如果此参数设为一个值，则表示更新报警联系人的该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1381111****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '将报警联系人的邮箱地址修改为此值。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。'."\n" + ."\n" + .'> 如果此参数为空，则表示删除报警联系人的该参数。如果此参数设为一个值，则表示更新报警联系人的该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'DingRobotWebhookUrl', + 'in' => 'query', + 'schema' => [ + 'description' => '将报警联系人的钉钉机器人Webhook URL修改为此值，获取方式请参见[设置钉钉机器人报警](~~106247~~)。PhoneNum、Email和DingRobotWebhookUrl必须至少填写一个。'."\n" + ."\n" + .'> 如果此参数为空，则表示删除报警联系人的该参数。如果此参数设为一个值，则表示更新报警联系人的该参数。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', + ], + ], + [ + 'name' => 'SystemNoc', + 'in' => 'query', + 'schema' => [ + 'description' => '是否接收系统通知：'."\n" + ."\n" + .'- `true`：接收系统通知'."\n" + .'- `false`：不接收系统通知', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。始终填写`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的报警联系人的ID，可调用SearchAlertContact接口来查询，详情请参见[SearchAlertContact](~~130703~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '更新联系人是否成功：'."\n" + ."\n" + .'- true：更新成功'."\n" + .'- false：更新失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', + ], + ], + ], + ], + ], + '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' => '更新报警联系人', + 'summary' => '调用UpdateAlertContact接口更新报警联系人。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateContact接口创建或修改告警联系人。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAlertContactGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '将报警联系人分组的名称修改为此值。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => [ + 'description' => '要包含在报警联系人分组内的联系人ID。多个联系人ID以空格分隔。可调用SearchAlertContact接口来查询联系人ID，详情请参见[SearchAlertContact](~~130703~~)。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '123 234 345', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更新的联系人分组的ID。可调用SearchAlertContactGroup接口来查询联系人分组ID，详情请参见[SearchAlertContactGroup](~~130671~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '123', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '更新联系人分组是否成功。'."\n" + ."\n" + .'- `true`：更新成功'."\n" + .'- `false`：更新失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9319A57D-2D9E-472A-B69B-CF3CD16D****', + ], + ], + ], + ], + ], + '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' => '更新报警联系人分组', + 'summary' => '调用UpdateAlertContactGroup接口更新报警联系人分组。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateContactGroup接口创建或修改告警联系人组。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateAlertRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人分组ID。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[123, 234]'."\n", + ], + ], + [ + 'name' => 'IsAutoStart', + 'in' => 'query', + 'schema' => [ + 'description' => '生成报警规则后是否自动启动报警规则。默认为`false`。'."\n" + ."\n" + .'- `true`：自动启动报警规则'."\n" + .'- `false`：不自动启动报警规则', + 'type' => 'boolean', + 'required' => false, + 'docRequired' => false, + 'example' => 'true', + ], + ], + [ + 'name' => 'TemplageAlertConfig', + 'in' => 'query', + 'schema' => [ + 'description' => 'ARMS报警规则的配置JSON串。'."\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" } ]', + ], + ], + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID，可调用SearchAlertRules接口查询，对应返回参数**Id**。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'example' => '1234567', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '返回信息。', + 'type' => 'string', + 'example' => '-', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '6A9AEA84-7186-4D8D-B498-4585C6A2****', + ], + 'AlertId' => [ + 'description' => '报警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1234567', + ], + ], + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"Data\\": \\"-\\",\\n \\"RequestId\\": \\"6A9AEA84-7186-4D8D-B498-4585C6A2****\\",\\n \\"AlertId\\": 1234567\\n}","type":"json"}]', + 'title' => '更新监控告警规则', + 'summary' => '调用UpdateAlertRule接口更新报警规则。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateAlertRule接口创建或修改告警规则。', + 'requestParamsDescription' => '## 关于参数**TemplageAlertConfig**的补充说明'."\n" + ."\n" + .'**报警模板JSON串示例及说明**'."\n" + ."\n" + .'```'."\n" + .'['."\n" + .' {'."\n" + ."\n" + .' "contactGroupIds": "381", // 报警通知发送的联系人分组ID，以半角逗号（,）分隔。报警模板中忽略，导入时会映射对应值。'."\n" + .' "alertType": 5, // 可选值为4和5。4表示前端监控报警，5表示应用监控报警。'."\n" + .' "alarmContext": { // 报警通知内容模板。'."\n" + .' "subTitle": "",'."\n" + .' "content": "报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！"'."\n" + .' },'."\n" + .' "alertLevel": "WARN", // 报警等级：FATAL、ERROR、WARN。'."\n" + .' "metricParam": {'."\n" + .' "appId": "70901", // 报警关联的应用AppId。模板报警配置中可随意填写，导入时会映射对应值。'."\n" + .' "pid": "atc889zkcf@d8deedfa9bf****", // 报警关联的应用Pid。模板报警配置中可随意填写，导入时会映射对应值。'."\n" + .' "type": "TXN", // 报警指标类型，详见下一节。'."\n" + .' "dimensions": [ // 报警关联的维度，详见下一节。'."\n" + .' {'."\n" + .' "type": "STATIC",'."\n" + .' "value": "\\\\/hello_test_api_address\\\\/test1",'."\n" + .' "key": "rpc"'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "alertWay": [ // 报警通知发送方式：SMS（开启短信通知）、MAIL（开启邮件通知）、DING_ROBOT（开启钉钉机器人通知）。'."\n" + .' "SMS",'."\n" + .' "MAIL",'."\n" + .' "DING_ROBOT"'."\n" + .' ],'."\n" + .' "alertRule": {'."\n" + .' "rules": [ // 报警判断规则列表'."\n" + .' {'."\n" + .' "measure": "appstat.txn.rt", // 报警规则请求指标，详见下一节。'."\n" + .' "alias": "入口调用响应时间_ms", // 报警规则请求指标展示字段，报警模板无需填此字段。'."\n" + .' "aggregates": "AVG", // 数据请求后聚合算子。AVG为取平均，SUM为取和，MIN为取最小值，MAX为取最大值。'."\n" + .' "nValue": 1, // 报警规则每分钟轮询请求几分钟的数据。'."\n" + .' "value": 1, // 报警规则判断阈值。'."\n" + .' "operator": "CURRENT_GTE" // CURRENT_GTE：大于或等于；CURRENT_LTE：小于或等于；PREVIOUS_UP：环比上升；PREVIOUS_DOWN：环比下降；HOH_UP：与上小时同比上升；HOH_DOWN：与上小时同比下降；DOD_UP：与昨日同比上升百分比；DOD_DOWN：与昨日同比下降百分比。'."\n" + .' }'."\n" + .' ],'."\n" + .' "operator": "|" // 表示多个判断条件的组合方式。&为与逻辑，|为或逻辑。'."\n" + .' },'."\n" + .' "title": "报警模板报警名", // 模板报警名称。导入后，会生成新报警名称“{title}-应用名”。'."\n" + .' "config": "{\\"continuous\\":false,\\"dataRevision\\":2,\\"ownerId\\":\\"123412341234\\"}", // continuous为true表示连续报警，continuous为false表示以24小时为静默期的静默报警策略。dataRevision字段为数据修订策略，0表示补零，1表示补1，2表示空值，即不处理。'."\n" + .' "notice": { // unix timstamp ms时间戳，noticeStartTime与noticeEndTime时间戳表示通知时间范围，startTime与endTime表示报警生效时间范围，timestamp转换为时间戳表示当天时间点，如1565964097071对应2019-08-16 22:01:37。'."\n" + .' "noticeStartTime": 1480521600000,'."\n" + .' "startTime": 1480521600000,'."\n" + .' "endTime": 1480607940000,'."\n" + .' "noticeEndTime": 1480607940000'."\n" + .' },'."\n" + .' "status": "NON" // 报警当前启动状态。报警模板中忽略此字段，导入时会映射对应值。'."\n" + .' }'."\n" + .']'."\n" + .'```'."\n" + ."\n" + .'**关于报警模板中Measure、Dimension、metricParam.type的说明**'."\n" + ."\n" + .'每个报警属于一个类型（type），由**metricParam.type**字段控制。每类报警都能设置一种维度（Dimension）作为筛选条件。每类报警都可以配置多个报警规则（alertRule），每个**alertRule**可以配置多个属于此类型的数据请求指标进行计算。'."\n" + ."\n" + .'**Dimensions.type**包含以下可选值：'."\n" + .'- `STATIC`： 固定匹配此维度值需要填**dimensions.value**。'."\n" + .'- `ALL`：遍历所有维度值，按此接口所有接口名的指标依次判断，哪个接口触发阈值引起报警，就会在报警内容中体现该接口名，此时不需要填**dimensions.value**。'."\n" + .'- `DISABLE`：聚合所有维度值为一个值（求和），此时不需要填**dimensions.value**。'."\n" + ."\n" + .'**报警指标取值枚举**'."\n" + ."\n" + .'- 报警类型（metricParam.type）：TXN（应用监控入口调用量）'."\n" + .' - 此类报警维度（dimensions.key）：rpc（接口名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.txn.rt：入口调用响应时间（毫秒）'."\n" + .' - appstat.txn.count：入口调用次数'."\n" + .' - appstat.txn.errcount：入口调用错误次数'."\n" + .'- 报警类型（metricParam.type）：TXN_TYPE（应用监控调用类型统计）'."\n" + .' - 此类报警维度（dimensions.key）：rpcType（接口调用类型，如HTTP、DUBBO）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.incall.rt：应用提供服务调用响应时间（毫秒）'."\n" + .' - appstat.incall.count：应用提供服务调用次数'."\n" + .' - appstat.incall.error：应用提供服务调用错误数'."\n" + .' - appstat.outcall.rt：应用依赖服务调用响应时间（毫秒）'."\n" + .' - appstat.outcall.count：应用依赖服务调用次数'."\n" + .' - appstat.outcall.error：应用依赖服务调用错误数'."\n" + .'- 报警类型（metricParam.type）：DB（数据库指标）'."\n" + .' - 此类报警维度（dimensions.key）：endpoint（数据库名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.database.rt：数据库调用响应时间（毫秒）'."\n" + .' - appstat.database.count：数据库调用次数'."\n" + .' - appstat.database.errcount：数据库调用错误次数'."\n" + .'- 报警类型（metricParam.type）：JVM（JVM监控）'."\n" + .' - 此类报警维度（dimensions.key）：rootIp（机器IP地址）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）： '."\n" + .' - appstat.jvm.heap_used：JVM堆内总内存量（字节）'."\n" + .' - appstat.jvm.GcPsScavengeCount：JVM垃圾回收次数'."\n" + .' - appstat.jvm.GcPsMarkSweepCount：JVM标记清除次数'."\n" + .' - appstat.jvm.GcG1OldGenCount：JVM_Old区G1GC次数'."\n" + .' - appstat.jvm.GcG1YoungGenCount：JVM_Young区G1GC次数'."\n" + .' - appstat.jvm.gc.YoungGcCountInstant：JVM_YoungGC次数'."\n" + .' - appstat.jvm.gc.OldGcCountInstant：JVM_FullGC次数'."\n" + .' - appstat.jvm.gc.YoungGcTimeInstant：JVM_YoungGC耗时（毫秒）'."\n" + .' - appstat.jvm.gc.OldGcTimeInstant：JVM_FullGC耗时（毫秒）'."\n" + .' - appstat.jvm.ThreadCount：JVM_线程总数'."\n" + .' - appstat.jvm.non_heap_used：JVM非堆总使用内存量（字节）'."\n" + .' - appstat.jvm.non_heap_max：JVM非堆内存最大值（字节）'."\n" + .' - appstat.jvm.non_heap_init：JVM非堆内存初始值（字节）'."\n" + .' - appstat.jvm.non_heap_committed：JVM非堆内存提交值（字节）'."\n" + .'- 报警类型（metricParam.type）：HOST（主机监控）'."\n" + .' - 此类报警维度（dimensions.key）：rootIp（机器IP地址）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.jvm.SystemCpuUser：节点机用户使用CPU（百分比）'."\n" + .' - appstat.jvm.SystemMemFree：节点机空闲内存（字节）'."\n" + .' - appstat.jvm.SystemDiskFree：节点机空闲磁盘（字节）'."\n" + .' - appstat.jvm.SystemNetInErrs：节点机接收错误报文数'."\n" + .' - appstat.jvm.SystemNetOutErrs：节点机发送错误报文数'."\n" + .' - appstat.jvm.SystemLoad：节点机系统负载'."\n" + .'- 报警类型（metricParam.type）：EXCEPTION（异常接口调用）'."\n" + .' - 此类报警维度（dimensions.key）：rpc（接口名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.exception.rt：应用异常接口调用响应时间（毫秒）'."\n" + .' - appstat.exception.count：应用异常接口调用次数', + ], + 'StartAlert' => [ + 'summary' => '调用StartAlert接口启动报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID，可调用SearchAlertRules接口查询，对应返回参数`Id`，详情请参见[SearchAlertRules](~~175825~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1610***', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。始终填写`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + ], + ], + ], + ], + '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' => '启动报警规则', + 'description' => '当前接口已不再维护，请使用新版告警管理CreateOrUpdateAlertRule接口的AlertStatus参数更新告警规则运行状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'StopAlert' => [ + 'summary' => '调用StartAlert接口停止报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID，可调用SearchAlertRules接口查询，对应返回参数`Id`，详情请参见[SearchAlertRules](~~175825~~)。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => '1610***', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。始终填写`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsSuccess' => [ + 'description' => '操作是否成功：'."\n" + ."\n" + .'- `true`：操作成功'."\n" + .'- `false`：操作失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '27E653FA-5958-45BE-8AA9-14D884DC****', + ], + ], + ], + ], + ], + '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' => '停止报警规则', + 'description' => '当前接口已不再维护，请使用新版告警管理CreateOrUpdateAlertRule接口的AlertStatus参数更新告警规则运行状态。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'UpdateDispatchRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44519', + 'abilityTreeNodes' => [ + 'FEATUREarmsVBCGEE', + ], + ], + 'parameters' => [ + [ + 'name' => 'DispatchRule', + 'in' => 'query', + 'schema' => [ + 'description' => '分派条件的配置JSON串。关于此字段的详细说明参见下文**关于参数DispatchRule的补充说明**。'."\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"] }, ], }', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Success' => [ + 'description' => '分派策略是否修改成功。'."\n" + ."\n" + .'- `true`：修改成功'."\n" + .'- `false`：修改失败', + 'type' => 'boolean', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'A5EC8221-08F2-4C95-9AF1-49FD998C****', + ], + ], + ], + ], + ], + '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' => '修改分派策略', + 'summary' => '调用UpdateDispatchRule接口修改分派策略。', + 'description' => '当前接口已不再维护，请使用新版告警管理的CreateOrUpdateNotificationPolicy接口创建或修改通知策略。', + 'requestParamsDescription' => '## 关于参数**DispatchRule**的补充说明'."\n" + .'**JSON串示例及说明**'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .' "id": 123, //分派策略ID。'."\n" + .' "system": false, //分派条件是否可编辑：true（不可编辑）、false（可编辑）。'."\n" + .' "ruleid": 10282, //分派规则ID。'."\n" + .' "name": "Prometheus Alert", //分派策略名称。'."\n" + .' "labelMatchExpressionGrid": {'."\n" + .' "labelMatchExpressionGroups": [ //设置分派条件。'."\n" + .' {'."\n" + .' "labelMatchExpressions": ['."\n" + .' {'."\n" + .' "key": "_aliyun_arms_involvedObject_kind", //分派条件标签，详见下一节。'."\n" + .' "value": "app", //标签取值。'."\n" + .' "operator": "eq" //eq：等于；re：匹配正则。'."\n" + .' }'."\n" + .' ]'."\n" + .' }'."\n" + .' ]'."\n" + .' },'."\n" + .' "dispatchType": "CREATE_ALERT/DISCARD_ALERT", //告警处理方式：CREATE_ALERT（就是生成报警），DISCARD_ALERT（丢弃报警事件，即不告警）'."\n" + .' "isRecover": true, //是否发生恢复的告警。true（发生），false（不发送）。'."\n" + .' "groupRules": [ //设置事件分组。'."\n" + .' {'."\n" + .' "groupId": 1, //分组ID。'."\n" + .' "groupingFields": [ //指定相同字段内容的事件分到一个组：设置分组字段，相同字段的告警内容会分别通过独立信息发送给处理人。'."\n" + .' "alertname"'."\n" + .' ],'."\n" + .' "groupWait": 10, //分组等待时间：收到第一个告警后会等待设置的时间，等待分组时间后收到的所有告警会以一条信息发送给处理人。'."\n" + .' "groupInterval": 15, //分组间隔时间：在重复告警静默时间内，如果有新告警产生，等待设置的时间后就会直接发送新的告警信息。'."\n" + .' "repeatInterval": 20 //重复告警静默时间：所有告警会以设置的时间间隔循环发送告警信息直至告警消失。'."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyRules": [ //设置通知规则。'."\n" + .' {'."\n" + .' "notifyObjects": ['."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT", //ARMS_CONTACT：联系人；ARMS_CONTACT_GROUP：联系人组。'."\n" + .' "name": "JohnDoe", //联系人或联系人组的名称。'."\n" + .' "notifyObjectId": 1 //联系人或联系人组的ID。'."\n" + .' },'."\n" + .' {'."\n" + .' "notifyType": "ARMS_CONTACT_GROUP",'."\n" + .' "name": "JohnDoe_group",'."\n" + .' "notifyObjectId": 2'."\n" + .' }'."\n" + .' ],'."\n" + .' "notifyChannels":["dingTalk","wechat","webhook","email"] //通知方式：dingTalk（ 钉钉）、sms（短信）、webhook、email（邮件）、wechat（微信）。'."\n" + .' },'."\n" + .' ],'."\n" + .'}'."\n" + .'```'."\n" + ."\n\n" + ."\n" + .'**分派标签取值枚举**'."\n" + ."\n" + .'- `_aliyun_arms_userid`：用户ID'."\n" + .'- `_aliyun_arms_involvedObject_kind`：关联对象类型'."\n" + .'- `_aliyun_arms_involvedObject_id`：关联对象ID'."\n" + .'- `_aliyun_arms_involvedObject_name`：关联对象名称 '."\n" + .'- `_aliyun_arms_alert_name`：告警名称'."\n" + .'- `_aliyun_arms_alert_rule_id`：告警规则对应的ID'."\n" + .'- `_aliyun_arms_alert_type`：告警类型 '."\n" + .'- `_aliyun_arms_alert_level`：告警等级 '."\n" + ."\n" + .' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchAlertRules' => [ + 'summary' => '调用SearchAlertRules接口查询报警规则。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44502', + 'abilityTreeNodes' => [ + 'FEATUREarms20UGKV', + ], + ], + 'parameters' => [ + [ + 'name' => 'Title', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'AlertRuleTitle', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则类型：'."\n" + ."\n" + .'- `1`：基于下钻数据集的自定义监控报警规则。'."\n" + .'- `3`：基于平铺数据集的自定义监控报警规则。'."\n" + .'- `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。'."\n" + .'- `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。'."\n" + .'- `6`：默认前端监控报警规则。'."\n" + .'- `7`：默认应用监控报警规则。'."\n" + .'- `8`：链路追踪Tracing Analysis报警规则。'."\n" + .'- `101`：Prometheus监控报警规则。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的页码。默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的每页项目数量。默认为`10`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警数据地域ID。**RegionId**和**SystemRegionId**的映射关系，请参见表格下方补充说明。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '<props="china">报警规则关联的ARMS应用的ID标识串。获取方式请参见[如何获取应用PID](https://help.aliyun.com/document_detail/186100.html?spm=a2c4g.11186623.6.792.1b50654cqcDPyk#title-imy-7gj-qhr)。</props>'."\n" + .'<props="intl">报警规则关联的ARMS应用的ID标识串。获取方式请参见[如何获取应用PID](https://www.alibabacloud.com/help/zh/doc-detail/186100.htm?spm=a2cdw.13409063.0.0.7a72281f0bkTfx#title-imy-7gj-qhr)。</props>', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则对应的应用类型，分为以下类型：'."\n" + ."\n" + .'- `TRACE`：应用监控报警规则 '."\n" + .'- `RETCODE`：前端监控报警规则', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'TRACE', + ], + ], + [ + 'name' => 'SystemRegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则所在地域ID。**RegionId**和**SystemRegionId**的映射关系，请参见表格下方补充说明。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源组ID，您可以通过**资源管理**控制台获取。', + 'type' => 'string', + 'required' => false, + 'example' => 'rg-acfmxyexli2****', + ], + ], + [ + 'name' => 'AlertRuleId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID。', + 'type' => 'string', + 'required' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '精确查找弹性伸缩资源时使用的标签键。标签键长度的取值范围：1~128。'."\n" + ."\n" + .'`Tags`用于精确查找绑定了指定标签的弹性伸缩资源，由一个键值对组成。'."\n" + .'- 仅指定`Tags.Key`时，则返回关联该标签键的所有资源。'."\n" + .'- 仅指定`Tags.Value`时，则出现`MissingParameter.TagKey`的报错提示。'."\n" + .'- 同时指定多个标签键值对时，仅同时满足所有标签键值对的弹性伸缩资源会被查找到。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestKey', + ], + 'Value' => [ + 'description' => '标签值。非必填，可以为空字符串。最多支持128个字符，不能以```acs:```开头，不能包含```http://```或者```https://```。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'PageBean' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '查询结果分页页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '查询结果分页的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '20', + ], + 'TotalCount' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'AlertRules' => [ + 'description' => '报警规则列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '报警规则状态。`RUNNING`表示运行中，`STOPPED`表示已停止。', + 'type' => 'string', + 'example' => 'RUNNING', + ], + 'UpdateTime' => [ + 'description' => '报警规则更新时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1480521600000', + ], + 'ContactGroupIdList' => [ + 'description' => '报警规则中联系人分组ID，多个ID以半角逗号（,）分隔。', + 'type' => 'string', + 'example' => '381*,572*', + ], + 'CreateTime' => [ + 'description' => '报警规则创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1579508519683', + ], + 'AlertTitle' => [ + 'description' => '报警规则名称。', + 'type' => 'string', + 'example' => 'TestAlertRule', + ], + 'UserId' => [ + 'description' => '报警规则所属用户的ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'AlertVersion' => [ + 'description' => '报警规则版本，默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'HostByAlertManager' => [ + 'description' => '是否标识告警是通过告警中心发送的通知。'."\n" + ."\n" + .'- `true`'."\n" + .'- `false`', + 'type' => 'boolean', + 'example' => 'true', + ], + 'AlertType' => [ + 'description' => '报警规则类型：'."\n" + ."\n" + .'- `1`：基于下钻数据集的自定义监控报警规则。'."\n" + .'- `3`：基于平铺数据集的自定义监控报警规则。'."\n" + .'- `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。'."\n" + .'- `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。'."\n" + .'- `6`：默认前端监控报警规则。'."\n" + .'- `7`：默认应用监控报警规则。'."\n" + .'- `8`：链路追踪Tracing Analysis报警规则。'."\n" + .'- `101`：Prometheus监控报警规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'ContactGroupIds' => [ + 'description' => '报警联系人分组ID，格式为JSONArray。', + 'type' => 'string', + 'example' => '[123, 234]', + ], + 'Config' => [ + 'description' => '报警规则的配置项，格式为JSON字符串。'."\n" + ."\n" + .'**continuous**的值包括：'."\n" + ."\n" + .'- `true`：每分钟均发送报警'."\n" + .'- `false`：打开报警静默期开关'."\n" + ."\n" + .'**dataRevision**表示未取得数据或者或数据为null值时的数据修订策略，包括：'."\n" + .' '."\n" + .'- `0`：补零策略。'."\n" + .'- `1`：补一策略。'."\n" + .'- `2`：补null （默认补null），将不对数据做处理，无数据时将不会生成报警事件。', + 'type' => 'string', + 'example' => '{\\"continuous\\":true,\\"dataRevision\\":2}', + ], + 'RegionId' => [ + 'description' => '报警规则所属的地域ID。', + 'type' => 'string', + 'example' => 'cn-hangzhou', + ], + 'AlertLevel' => [ + 'description' => '报警通知级别，目前只支持`WARN`。', + 'type' => 'string', + 'example' => 'WARN', + ], + 'TaskStatus' => [ + 'description' => '内部字段。', + 'type' => 'string', + 'example' => '""', + ], + 'Title' => [ + 'description' => '报警名称。', + 'type' => 'string', + 'example' => 'AlertTest', + ], + 'TaskId' => [ + 'description' => '基于任务的自定义监控报警规则所关联的ARMS任务ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Id' => [ + 'description' => '报警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'AlertWays' => [ + 'description' => '报警通知发送方式。', + 'type' => 'array', + 'items' => [ + 'description' => '报警通知发送方式：'."\n" + ."\n" + .'- `SMS`：短信'."\n" + .'- `MAIL`：邮件'."\n" + .'- `DING_ROBOT`：钉钉机器人', + 'type' => 'string', + 'example' => '["MAIL", "SMS", "DING_ROBOT"]', + ], + ], + 'AlarmContext' => [ + 'description' => '报警发送消息格式。', + 'type' => 'object', + 'properties' => [ + 'AlarmContentTemplate' => [ + 'description' => '报警通知内容模板。', + 'type' => 'string', + 'example' => '报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！', + ], + 'SubTitle' => [ + 'description' => '报警通知子标题。', + 'type' => 'string', + 'example' => 'test', + ], + 'AlarmContentSubTitle' => [ + 'description' => '报警内容子标题。', + 'type' => 'string', + 'example' => 'TestSubTitle', + ], + 'Content' => [ + 'description' => '报警通知内容。', + 'type' => 'string', + 'example' => '报警名称：$报警名称\\n筛选条件：$筛选\\n报警时间：$报警时间\\n报警内容：$报警内容\\n注意：该报警未收到恢复邮件之前，正在持续报警中，24小时后会再次提醒您！', + ], + ], + ], + 'AlertRule' => [ + 'description' => '报警规则判断条件列表。支持多个条件，条件间用“与逻辑”或“或逻辑”连接。', + 'type' => 'object', + 'properties' => [ + 'Operator' => [ + 'description' => '报警规则判断逻辑。`&`表示“与”逻辑，`|`表示“或”逻辑。', + 'type' => 'string', + 'example' => '|', + ], + 'Rules' => [ + 'description' => '报警规则判断条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Measure' => [ + 'description' => '<props="china">报警规则数据指标，根据这些指标判断是否符合报警规则条件。更多信息，请参见[报警指标取值枚举](https://help.aliyun.com/document_detail/175825.html#h2-url-4)。</props>'."\n" + .'<props="intl">报警规则数据指标，根据这些指标判断是否符合报警规则条件。更多信息，请参见[报警指标取值枚举](https://www.alibabacloud.com/help/zh/doc-detail/175825.htm?spm=a2c63.p38356.b99.373.61d25830rs3HHm#h2-url-4)。</props>', + 'type' => 'string', + 'example' => 'appstat.jvm.SystemDiskFree', + ], + 'Value' => [ + 'description' => '报警规则判断条件的判断阈值。', + 'type' => 'number', + 'format' => 'float', + 'example' => '30', + ], + 'Aggregates' => [ + 'description' => '报警判断规则的聚合逻辑：'."\n" + ."\n" + .'- `AVG`：每分钟求平均 '."\n" + .'- `SUM`：每分钟值求和 '."\n" + .'- `MAX`：每分钟最大值 '."\n" + .'- `MIN`：每分钟最小值', + 'type' => 'string', + 'example' => 'AVG', + ], + 'NValue' => [ + 'description' => '报警规则判断条件的数据请求范围，单位为分钟。例如，NValue=5表示每分钟报警将请求最近5分钟的数据。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '5', + ], + 'Operator' => [ + 'description' => '报警规则判断条件的判断符号：'."\n" + ."\n" + .'- CURRENT_GTE：大于或等于'."\n" + .'- CURRENT_LTE：小于或等于'."\n" + .'- PREVIOUS_UP：环比上升百分比'."\n" + .'- PREVIOUS_DOWN：环比下降百分比'."\n" + .'- HOH_UP：与上小时同比上升百分比'."\n" + .'- HOH_DOWN：与上小时同比下降百分比'."\n" + .'- DOD_UP：与昨日同比上升百分比'."\n" + .'- DOD_DOWN：与昨日同比下降百分比', + 'type' => 'string', + 'example' => 'CURRENT_GTE', + ], + 'Alias' => [ + 'description' => '报警指标的展示文本。', + 'type' => 'string', + 'example' => '调用响应时间_ms', + ], + ], + ], + ], + ], + ], + 'MetricParam' => [ + 'description' => '报警规则关联应用信息配置。', + 'type' => 'object', + 'properties' => [ + 'Type' => [ + 'description' => '报警规则指标的类型。'."\n" + ."\n" + .'- `txn`：应用监控入口调用量'."\n" + .'- `txn_type`：应用监控调用类型统计'."\n" + .'- `db`：数据库指标'."\n" + .'- `jvm`：JVM监控'."\n" + .'- `host`：主机监控'."\n" + .'- `exception`：异常接口调用', + 'type' => 'string', + 'example' => 'DB', + ], + 'AppGroupId' => [ + 'description' => '报警关联应用的应用子分组ID，适用于EDAS应用分组场景。', + 'type' => 'string', + 'example' => 'DEFAULT', + ], + 'AppId' => [ + 'description' => 'ARMS应用的自增ID，可忽略。', + 'type' => 'string', + 'example' => '123', + ], + 'Pid' => [ + 'description' => '报警规则关联的应用的ID。', + 'type' => 'string', + 'example' => '9870ca99-8105-4da7-a3a4-d72dd1b1****', + ], + 'Dimensions' => [ + 'description' => '报警规则判断条件中的维度条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '维度名称，包括以下值：'."\n" + ."\n" + .'- `rpc`：接口名称'."\n" + .'- `rpcType`：接口调用类型（如HTTP、DUBBO）'."\n" + .'- `endpoint`：数据库名称'."\n" + .'- `rootIp`：机器IP地址', + 'type' => 'string', + 'example' => 'rootIp', + ], + 'Type' => [ + 'description' => '维度条件的类型，包含以下可选值：'."\n" + ."\n" + .'- `STATIC`： 固定匹配此维度值需要填**dimensions.value**。'."\n" + .'- `ALL`：遍历所有维度值，按此接口所有接口名的指标依次判断，哪个接口触发阈值引起报警，就会在报警内容中体现该接口名，此时不需要填**dimensions.value**。'."\n" + .'- `DISABLE`：聚合所有维度值为一个值（求和），此时不需要填**dimensions.value**。', + 'type' => 'string', + 'example' => 'DISABLE', + ], + 'Value' => [ + 'description' => '维度选项的值。', + 'type' => 'string', + 'example' => '"127.0.0.1"', + ], + ], + ], + ], + ], + ], + 'Notice' => [ + 'description' => '报警规则的生效时间范围和通知时间范围。', + 'type' => 'object', + 'properties' => [ + 'EndTime' => [ + 'description' => '报警规则生效时间范围的结束时间的时间戳，控制报警规则在每天24小时中的生效时间范围。格式为UNIX时间戳，其中年月日不生效，只有时分秒生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1480607940000', + ], + 'NoticeEndTime' => [ + 'description' => '报警规则通知时间范围的结束时间的时间戳，控制报警规则在每天24小时中的通知时间范围。格式为UNIX时间戳，其中年月日不生效，只有时分秒生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1480607940000', + ], + 'StartTime' => [ + 'description' => '报警规则生效时间范围的开始时间的时间戳，控制报警规则在每天24小时中的生效时间范围。格式为UNIX时间戳，其中年月日不生效，只有时分秒生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1480521600000', + ], + 'NoticeStartTime' => [ + 'description' => '报警规则通知时间范围的开始时间的时间戳，控制报警规则在每天24小时中的通知时间范围。格式为UNIX时间戳，其中年月日不生效，只有时分秒生效。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1480521600000', + ], + ], + ], + 'ResourceGroupId' => [ + 'description' => '资源组ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询报警规则', + 'description' => '当前接口已不再维护，请使用新版告警管理的GetAlertRules接口查询已经创建的告警规则。', + 'requestParamsDescription' => '### **RegionId**和**SystemRegionId**的映射关系。'."\n" + .'SearchAlertRules接口会根据设置的**SystemRegionId**参数获取指定报警地域的报警规则。'."\n" + ."\n" + .'- 如果**SystemRegionId**参数未设置，后端会自动同步**SystemRegionId**值为**RegionId**值。'."\n" + .'- 如果设置了**SystemRegionId**参数，**RegionId**则必须根据以下映射关系设置，否则将无法返回数据。'."\n" + ."\n" + .'|RegionId|SystemRegionId|'."\n" + .'|---|---|'."\n" + .'|cn-hangzhou（杭州）|cn-hangzhou（杭州）|'."\n" + .'|cn-hangzhou（杭州）|cn-shanghai（上海）|'."\n" + .'|cn-hangzhou（杭州）|cn-qingdao（青岛）|'."\n" + .'|cn-hangzhou（杭州）|cn-beijing（北京）|'."\n" + .'|cn-hangzhou（杭州）|cn-zhangjiakou（张家口）|'."\n" + .'|cn-hangzhou（杭州）|cn-huhehaote（呼和浩特）|'."\n" + .'|cn-hangzhou（杭州）|cn-shenzhen（深圳）|'."\n" + .'|cn-hangzhou（杭州）|cn-chengdu（成都）|'."\n" + .'|cn-hangzhou（杭州）|cn-hongkong（中国香港）|'."\n" + .'|ap-southeast-1（新加坡）|ap-southeast-1（新加坡）|'."\n" + .'|ap-southeast-1（新加坡）|ap-southeast-2（悉尼）|'."\n" + .'|ap-southeast-1（新加坡）|ap-southeast-3（吉隆坡）|'."\n" + .'|ap-southeast-1（新加坡）|ap-southeast-5（雅加达）|'."\n" + .'|ap-southeast-1（新加坡）|ap-south-1（孟买）|'."\n" + .'|ap-southeast-1（新加坡）|me-east-1（迪拜）|'."\n" + .'|ap-southeast-1（新加坡）|ap-southeast-6（马尼拉）|'."\n" + .'|ap-northeast-1（东京）|ap-northeast-1（东京）|'."\n" + .'|us-west-1（硅谷）|us-west-1（硅谷）|'."\n" + .'|us-west-1（硅谷）|us-east-1（弗吉尼亚）|'."\n" + .'|eu-west-1（伦敦）|eu-central-1（法兰克福）|'."\n" + .'|eu-west-1（伦敦）|eu-west-1（伦敦）|'."\n" + .'|cn-hangzhou-finance（杭州金融云）|cn-shanghai-finance-1（上海金融云）|'."\n" + .'|cn-hangzhou-finance（杭州金融云）|cn-hangzhou-finance（杭州金融云）|'."\n" + ."\n" + .'例如：需要获取上海地域的报警数据，可以进行以下设置：'."\n" + ."\n" + .'- 设置**RegionId**为**cn-shanghai**，不设置**SystemRegionId**参数。'."\n" + .'- 设置**RegionId**为**cn-hangzhou**，设置**SystemRegionId**为**cn-shanghai**。'."\n" + ."\n" + .'如果您需要查询法兰克福地域的报警规则，请设置**RegionId**为**eu-west-1**，设置**SystemRegionId**为**eu-central-1**。', + 'responseParamsDescription' => '## 报警指标取值枚举'."\n" + ."\n" + .'- 报警类型（metricParam.type）：TXN（应用监控入口调用量）'."\n" + .' - 此类报警维度（dimensions.key）：rpc（接口名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.txn.rt：入口调用响应时间（毫秒）'."\n" + .' - appstat.txn.count：入口调用次数'."\n" + .' - appstat.txn.errcount：入口调用错误次数'."\n" + .'- 报警类型（metricParam.type）：TXN_TYPE（应用监控调用类型统计）'."\n" + .' - 此类报警维度（dimensions.key）：rpcType（接口调用类型，如HTTP、DUBBO）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.inbound.rt：应用提供服务调用响应时间（毫秒）'."\n" + .' - appstat.inbound.count：应用提供服务调用次数'."\n" + .' - appstat.inbound.error：应用提供服务调用错误数'."\n" + .' - appstat.outbound.rt：应用依赖服务调用响应时间（毫秒）'."\n" + .' - appstat.outbound.count：应用依赖服务调用次数'."\n" + .' - appstat.outbound.error：应用依赖服务调用错误数'."\n" + .'- 报警类型（metricParam.type）：DB（数据库指标）'."\n" + .' - 此类报警维度（dimensions.key）：endpoint（数据库名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.database.rt：数据库调用响应时间（毫秒）'."\n" + .' - appstat.database.count：数据库调用次数'."\n" + .' - appstat.database.errcount：数据库调用错误次数'."\n" + .'- 报警类型（metricParam.type）：JVM（JVM监控）'."\n" + .' - 此类报警维度（dimensions.key）：rootIp（机器IP地址）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）： '."\n" + .' - appstat.jvm.heap_used：JVM堆内总内存量（字节）'."\n" + .' - appstat.jvm.GcPsScavengeCount：JVM垃圾回收次数'."\n" + .' - appstat.jvm.GcPsMarkSweepCount：JVM标记清除次数'."\n" + .' - appstat.jvm.GcG1OldGenCount：JVM_Old区G1GC次数'."\n" + .' - appstat.jvm.GcG1YoungGenCount：JVM_Young区G1GC次数'."\n" + .' - appstat.jvm.gc.YoungGcCountInstant：JVM_YoungGC次数'."\n" + .' - appstat.jvm.gc.OldGcCountInstant：JVM_FullGC次数'."\n" + .' - appstat.jvm.gc.YoungGcTimeInstant：JVM_YoungGC耗时（毫秒）'."\n" + .' - appstat.jvm.gc.OldGcTimeInstant：JVM_FullGC耗时（毫秒）'."\n" + .' - appstat.jvm.ThreadCount：JVM_线程总数'."\n" + .' - appstat.jvm.non_heap_used：JVM非堆总使用内存量（字节）'."\n" + .' - appstat.jvm.non_heap_max：JVM非堆内存最大值（字节）'."\n" + .' - appstat.jvm.non_heap_init：JVM非堆内存初始值（字节）'."\n" + .' - appstat.jvm.non_heap_committed：JVM非堆内存提交值（字节）'."\n" + .'- 报警类型（metricParam.type）：HOST（主机监控）'."\n" + .' - 此类报警维度（dimensions.key）：rootIp（机器IP地址）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.jvm.SystemCpuUser：节点机用户使用CPU（百分比）'."\n" + .' - appstat.jvm.SystemMemFree：节点机空闲内存（字节）'."\n" + .' - appstat.jvm.SystemDiskFree：节点机空闲磁盘（字节）'."\n" + .' - appstat.jvm.SystemNetInErrs：节点机接收错误报文数'."\n" + .' - appstat.jvm.SystemNetOutErrs：节点机发送错误报文数'."\n" + .' - appstat.jvm.SystemLoad：节点机系统负载'."\n" + .'- 报警类型（metricParam.type）：EXCEPTION（异常接口调用）'."\n" + .' - 此类报警维度（dimensions.key）：rpc（接口名称）'."\n" + .' - 此类报警数据请求指标（alertRule.rules.measure）：'."\n" + .' - appstat.exception.rt：应用异常接口调用响应时间（毫秒）'."\n" + .' - appstat.exception.count：应用异常接口调用次数', + 'extraInfo' => ' ', + ], + 'SearchAlertContact' => [ + 'summary' => '调用SearchAlertContact接口查询报警联系人。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'John Doe', + ], + ], + [ + 'name' => 'Phone', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人电话号码。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1381111*****', + ], + ], + [ + 'name' => 'Email', + 'in' => 'query', + 'schema' => [ + 'description' => '联系人邮箱地址。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '[email protected]', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的当前页码。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询分页的每页项目数量。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => '20', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。始终填写`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人ID。', + 'type' => 'string', + 'required' => false, + 'example' => '[12345]', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'description' => '响应对象。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '21E85B16-75A6-429A-9F65-8AAC9A54****', + ], + 'PageBean' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '返回结果的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '返回结果的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '返回结果的总项数数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '23', + ], + 'Contacts' => [ + 'description' => '联系人对象列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '更新时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1580258717000', + ], + 'DingRobot' => [ + 'description' => '钉钉机器人Webhook URL。', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', + ], + 'Webhook' => [ + 'description' => 'Webhook信息。', + 'type' => 'string', + 'example' => '{\\"body\\":\\"{ \\\\\\"msg_type\\\\\\": \\\\\\"text\\\\\\", \\\\\\"content\\\\\\": { \\\\\\"text\\\\\\": \\\\\\"$content\\\\\\" } }\\",\\"header\\":{\\"Arms-Content-Type\\":\\"json\\"},\\"method\\":\\"post\\",\\"params\\":{},\\"url\\":\\"https://***",\\"userId\\":\\"1131971649***\\"}",', + ], + 'Email' => [ + 'description' => '联系人邮箱地址。', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ContactId' => [ + 'description' => '联系人ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1572349025000', + ], + 'UserId' => [ + 'description' => '用户ID。', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'ContactName' => [ + 'description' => '联系人名称。', + 'type' => 'string', + 'example' => 'John Doe', + ], + 'SystemNoc' => [ + 'description' => '是否接收系统通知：'."\n" + ."\n" + .'- `true`：接收系统通知。'."\n" + .'- `false`：不接收系统通知。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Content' => [ + 'description' => '联系人所在的联系人组。如果联系人被添加至多个联系人组中，则多个联系人组之间会使用竖线（|）分隔。', + 'type' => 'string', + 'example' => '默认分组|SRE分组', + ], + 'Phone' => [ + 'description' => '联系人电话号码。', + 'type' => 'string', + 'example' => '1381111*****', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-acfmxyexli2****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\",\\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>[email protected]</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' => '查询报警联系人', + 'description' => '当前接口已不再维护，请使用新版告警管理的DescribeContacts接口查询告警联系人列表。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchAlertContactGroup' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'ContactGroupName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人分组名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'TestGroup', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ContactName', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人名称。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'John Doe', + ], + ], + [ + 'name' => 'ContactId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人ID。可调用SearchAlertContact接口来查询联系人ID，请参见[SearchAlertContact](~~130703~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'ContactGroupIds', + 'in' => 'query', + 'schema' => [ + 'description' => '报警联系人分组ID。可以同时查询多个联系人分组ID，联系人分组ID之间用英文逗号（,）分隔。', + 'type' => 'string', + 'required' => false, + 'example' => '746', + ], + ], + [ + 'name' => 'IsDetail', + 'in' => 'query', + 'schema' => [ + 'description' => '是否返回联系人分组中包含的所有联系人。默认不返回所有联系人。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '4D6C358A-A58B-4F4B-94CE-F5AAF023****', + ], + 'ContactGroups' => [ + 'description' => '报警联系人分组信息', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '更新时间的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529668855000', + ], + 'ContactGroupName' => [ + 'description' => '报警联系人分组名称', + 'type' => 'string', + 'example' => 'TestGroup', + ], + 'ContactGroupId' => [ + 'description' => '报警联系人分组ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '746', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1529668855000', + ], + 'UserId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'Contacts' => [ + 'description' => '联系人对象列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'UpdateTime' => [ + 'description' => '更新时间的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1580258717000', + ], + 'DingRobot' => [ + 'description' => '钉钉机器人Webhook URL', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f6****', + ], + 'Email' => [ + 'description' => '联系人邮箱地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'ContactId' => [ + 'description' => '联系人ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'CreateTime' => [ + 'description' => '创建时间的时间戳', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1572349025000', + ], + 'UserId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'ContactName' => [ + 'description' => '联系人名称', + 'type' => 'string', + 'example' => 'John Doe', + ], + 'SystemNoc' => [ + 'description' => '是否接收系统通知：'."\n" + ."\n" + .'- true：接收系统通知'."\n" + .'- false：不接收系统通知', + 'type' => 'boolean', + 'example' => 'false', + ], + 'Phone' => [ + 'description' => '联系人电话号码', + 'type' => 'string', + 'example' => '1381111*****', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\",\\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>[email protected]</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' => '查询报警联系人分组', + 'summary' => '调用SearchAlertContactGroup接口查询报警联系人分组。', + 'description' => '当前接口已不再维护，请使用新版告警管理的DescribeContactGroups接口查询告警联系人分组信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchAlertHistories' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44501', + 'abilityTreeNodes' => [ + 'FEATUREarmsEYPVV6', + ], + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID，可调用SearchAlertRules接口获取（对应返回参数中的`Id`），详情请参见[SearchAlertRules](~~175825~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'AlertType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则类型：'."\n" + ."\n" + .'- `1`：基于下钻数据集的自定义监控报警规则。'."\n" + .'- `3`：基于平铺数据集的自定义监控报警规则。'."\n" + .'- `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。'."\n" + .'- `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。'."\n" + .'- `6`：默认前端监控报警规则。'."\n" + .'- `7`：默认应用监控报警规则。'."\n" + .'- `8`：链路追踪Tracing Analysis报警规则。'."\n" + .'- `101`：Prometheus报警规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的页码。默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的每页项目数量。默认为`10`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为`cn-hangzhou`。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史记录的开始时间的时间戳。格式为Unix Timestamp Long，单位为毫秒。默认为当前时间的前10分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1595568910000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警历史记录的结束时间的时间戳。格式为Unix Timestamp Long，单位为毫秒。默认为当前时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1579499626000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID', + 'type' => 'string', + 'example' => '2FC13182-B9AF-4E6B-BE51-72669B7C****', + ], + 'PageBean' => [ + 'description' => '返回结构体', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '查询结果分页的页码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '查询结果分页的每页项目数量', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果总数', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'AlarmHistories' => [ + 'description' => '报警历史对象列表', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'AlarmTime' => [ + 'description' => '报警发送时间', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1595564179000', + ], + 'StrategyId' => [ + 'description' => '内部字段', + 'type' => 'string', + 'example' => '""', + ], + 'AlarmResponseCode' => [ + 'description' => '报警投递返回的状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Emails' => [ + 'description' => '接收报警的邮箱地址', + 'type' => 'string', + 'example' => '[email protected]', + ], + 'UserId' => [ + 'description' => '用户ID', + 'type' => 'string', + 'example' => '113197164949****', + ], + 'AlarmSources' => [ + 'description' => '报警Webhook（如钉钉机器人Webhook地址）', + 'type' => 'string', + 'example' => 'https://oapi.dingtalk.com/robot/send?access_token=91f2f65002fefe0ab9b71e6590c5ca504348cad742ff01e9c8ab204439ca****', + ], + 'AlarmContent' => [ + 'description' => '报警内容', + 'type' => 'string', + 'example' => '"报警名称：Alert1\\n报警时间：2020-07-24 12:14:00\\n报警内容：共有4条记录触发异常：****"', + ], + 'Phones' => [ + 'description' => '接收报警的手机号码', + 'type' => 'string', + 'example' => '1381111****', + ], + 'AlarmType' => [ + 'description' => '报警规则类型（默认为4）：'."\n" + ."\n" + .'- `1`：基于下钻数据集的自定义监控报警规则。'."\n" + .'- `3`：基于平铺数据集的自定义监控报警规则。'."\n" + .'- `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。'."\n" + .'- `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。'."\n" + .'- `6`：默认前端监控报警规则。'."\n" + .'- `7`：默认应用监控报警规则。'."\n" + .'- `8`：链路追踪Tracing Analysis报警规则。'."\n" + .'- `101`：Prometheus监控报警规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'Target' => [ + 'description' => '内部字段', + 'type' => 'string', + 'example' => '""', + ], + 'Id' => [ + 'description' => '报警发送记录ID', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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\\": \\"[email protected]\\",\\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>[email protected]</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' => '查询报警规则的报警发送记录', + 'summary' => '调用SearchAlertHistories接口查询报警规则的报警发送记录。', + 'description' => '当前接口已不再维护，请使用新版告警管理的ListAlerts接口查询告警发送历史。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'SearchEvents' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'AlertId', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则ID，可调用SearchAlertRules接口获取（对应返回参数中的`Id`），更多信息，请参见[SearchAlertRules](~~175825~~)。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '123', + ], + ], + [ + 'name' => 'Pid', + 'in' => 'query', + 'schema' => [ + 'description' => '报警关联应用的应用ID（PID）。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'atc889zkcf@d8deedfa9bf****', + ], + ], + [ + 'name' => 'CurrentPage', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的页码。默认为`1`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '查询结果分页的每页项目数量。默认为`10`。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '10', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'AppType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则关联应用的类型：'."\n" + ."\n" + .'- `TRACE`：应用监控。'."\n" + .'- `RETCODE`：前端监控。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'TRACE', + ], + ], + [ + 'name' => 'AlertType', + 'in' => 'query', + 'schema' => [ + 'description' => '报警规则类型：'."\n" + ."\n" + .'- `1`：基于下钻数据集的自定义监控报警规则。'."\n" + .'- `3`：基于平铺数据集的自定义监控报警规则。'."\n" + .'- `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。'."\n" + .'- `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。'."\n" + .'- `6`：默认前端监控报警规则。'."\n" + .'- `7`：默认应用监控报警规则。'."\n" + .'- `8`：链路追踪Tracing Analysis报警规则。'."\n" + .'- `101`：Prometheus监控报警规则。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '4', + ], + ], + [ + 'name' => 'IsTrigger', + 'in' => 'query', + 'schema' => [ + 'description' => '报警事件是否被触发，若不填写则查询全部。'."\n" + ."\n" + .'- `1`：触发'."\n" + .'- `0`：未触发', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => false, + 'example' => '1', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警事件的开始时间的时间戳。格式为Unix Timestamp Long，单位为毫秒。默认为当前时间的前10分钟。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1595565300000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '查询报警事件的结束时间的时间戳。格式为Unix Timestamp Long，单位为毫秒。默认为当前时间。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => false, + 'docRequired' => false, + 'example' => '1595568970000', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'IsTrigger' => [ + 'description' => '报警事件是否被触发，若不填写则查询全部。'."\n" + ."\n" + .'- `1`：触发'."\n" + .'- `0`：未触发', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '0', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '32940175-181B-4B93-966E-4BB69176****', + ], + 'PageBean' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'PageNumber' => [ + 'description' => '查询结果分页的页码。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '查询结果分页的每页项目数量。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '10', + ], + 'TotalCount' => [ + 'description' => '查询结果总数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '2', + ], + 'Event' => [ + 'description' => '报警事件列表。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'EventTime' => [ + 'description' => '事件发生时间的时间戳。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1595569020000', + ], + 'EventLevel' => [ + 'description' => '事件等级。', + 'type' => 'string', + 'example' => '1', + ], + 'AlertRule' => [ + 'description' => '事件关联的报警规则判断条件配置。', + 'type' => 'string', + 'example' => '{\\"operator\\":\\"&\\",\\"rules\\":[{\\"aggregates\\":\\"AVG\\",\\"alias\\":\\"JVM_线程总数\\",\\"measure\\":\\"appstat.jvm.ThreadCount\\",\\"nValue\\":1,\\"operator\\":\\"HOH_DOWN\\",\\"value\\":50.0}]}', + ], + 'Message' => [ + 'description' => '事件内容，为JSONString格式，键表示维度，值表示此维度的报警内容。', + 'type' => 'string', + 'example' => 'unknow紧急报警\\nip：172.27.XX.XX\\n应用名 = test\\nRegion = cn-shenzhen\\n异常信息 = {\\"timestamp\\"：\\"1615447972235\\"}', + ], + 'AlertType' => [ + 'description' => '事件关联的报警规则类型（一般不展示）：'."\n" + ."\n" + .'- `1`：基于下钻数据集的自定义监控报警规则。'."\n" + .'- `3`：基于平铺数据集的自定义监控报警规则。'."\n" + .'- `4`：前端监控报警规则，包含默认前端监控报警规则（AlertType=6）。'."\n" + .'- `5`：应用监控报警规则，包含默认应用监控报警规则（AlertType=7）。'."\n" + .'- `6`：默认前端监控报警规则。'."\n" + .'- `7`：默认应用监控报警规则。'."\n" + .'- `8`：链路追踪Tracing Analysis报警规则。'."\n" + .'- `101`：Prometheus监控报警规则。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '4', + ], + 'AlertName' => [ + 'description' => '事件关联的报警规则名称。', + 'type' => 'string', + 'example' => 'alertName', + ], + 'Id' => [ + 'description' => '事件记录ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'AlertId' => [ + 'description' => '事件关联的报警规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '123', + ], + 'Links' => [ + 'description' => '链接列表。', + 'type' => 'array', + 'items' => [ + 'description' => '事件还原现场链接列表。', + 'type' => 'string', + 'example' => '[ "http://arms.console.aliyun.com/apm?startTime=1595565300000&endTime=1595569246633®ionId=cn-hangzhou&pid=****" ]', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询报警事件记录', + 'summary' => '调用SearchEvents接口查询报警事件记录。', + 'description' => '报警事件记录，不是报警发送记录。是报警规则每分钟轮询判断后的事件记录。分为触发与未触发。触发的事件，如果没有在静默期中，将会被发送。'."\n" + ."\n" + .'> 当前接口已不再维护，请使用新版告警管理的ListAlertEvents接口查询告警事件历史。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'DescribeDispatchRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'abilityTreeCode' => '44446', + 'abilityTreeNodes' => [ + 'FEATUREarmsVBCGEE', + ], + ], + 'parameters' => [ + [ + 'name' => 'Id', + 'in' => 'query', + 'schema' => [ + 'description' => '分派策略ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => false, + 'example' => '12345', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3****', + ], + 'DispatchRule' => [ + 'description' => '返回结构体。'."\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n" + ."\n\n", + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '分派策略名称。', + 'type' => 'string', + 'example' => 'Prometheus Alert', + ], + 'IsRecover' => [ + 'description' => '是否发送恢复的告警。'."\n" + ."\n" + .'- `true`：发送'."\n" + .'- `false`：不发送', + 'type' => 'boolean', + 'example' => 'true', + ], + 'DispatchType' => [ + 'description' => '告警处理方式。'."\n" + ."\n" + .'- CREATE_ALERT：生成报警。'."\n" + .'- DISCARD_ALERT：丢弃报警事件，即不告警。', + 'type' => 'string', + 'example' => 'CREATE_ALERT', + ], + 'State' => [ + 'description' => '是否启用该分派策略。'."\n" + ."\n" + .'- `true`：启用'."\n" + .'- `false`：关闭', + 'type' => 'string', + 'example' => 'true', + ], + 'RuleId' => [ + 'description' => '分派规则ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10282', + ], + 'GroupRules' => [ + 'description' => '事件分组。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'RepeatInterval' => [ + 'description' => '重复告警静默时间。所有告警会以设置的时间间隔循环发送告警信息直至告警消失，单位为秒。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '20', + ], + 'GroupId' => [ + 'description' => '分组ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '1', + ], + 'GroupWaitTime' => [ + 'description' => '分组等待时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'GroupInterval' => [ + 'description' => '分组间隔时间。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '15', + ], + 'GroupingFields' => [ + 'description' => '分组字段列表。', + 'type' => 'array', + 'items' => [ + 'description' => '分组字段列表。', + 'type' => 'string', + 'example' => '_aliyun_arms_involvedObject_kind', + ], + ], + ], + ], + ], + 'NotifyRules' => [ + 'description' => '通知方式集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyObjects' => [ + 'description' => '通知对象集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'NotifyObjectId' => [ + 'description' => '联系人或联系人组的ID。', + 'type' => 'string', + 'example' => '1', + ], + 'NotifyType' => [ + 'description' => '通知对象类型：'."\n" + ."\n" + .'- `CONTACT`：联系人'."\n" + .'- `CONTACT_GROUP`：联系人组', + 'type' => 'string', + 'example' => 'CONTACT', + ], + 'Name' => [ + 'description' => '联系人或联系人组的名称。', + 'type' => 'string', + 'example' => 'JohnDoe', + ], + ], + ], + ], + 'NotifyChannels' => [ + 'description' => '通知方式列表。', + 'type' => 'array', + 'items' => [ + 'description' => '通知方式：'."\n" + ."\n" + .'- `dingTalk`'."\n" + .'- `sms`'."\n" + .'- `webhook`'."\n" + .'- `email`'."\n" + .'- `wechat`'."\n" + ."\n", + 'type' => 'string', + 'example' => 'email', + ], + ], + ], + ], + ], + 'LabelMatchExpressionGrid' => [ + 'description' => '分派规则。', + 'type' => 'object', + 'properties' => [ + 'LabelMatchExpressionGroups' => [ + 'description' => '分派条件集合。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'LabelMatchExpressions' => [ + 'description' => '分派规则的条件。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '分派条件标签：'."\n" + ."\n" + .'- `_aliyun_arms_userid` ：用户ID'."\n" + .'- `_aliyun_arms_involvedObject_kind`：关联对象类型'."\n" + .'- `_aliyun_arms_involvedObject_id`：关联对象ID'."\n" + .'- `_aliyun_arms_involvedObject_name`：关联对象名称'."\n" + .'- `_aliyun_arms_alert_name`：告警名称'."\n" + .'- `_aliyun_arms_alert_rule_id`：告警规则对应的ID'."\n" + .'- `_aliyun_arms_alert_type`：告警类型'."\n" + .'- `_aliyun_arms_alert_level`：告警等级', + 'type' => 'string', + 'example' => '_aliyun_arms_involvedObject_kind', + ], + 'Value' => [ + 'description' => '标签取值。', + 'type' => 'string', + 'example' => 'app', + ], + 'Operator' => [ + 'description' => '选项：'."\n" + ."\n" + .'- `eq`：等于'."\n" + .'- `re`：匹配正则', + 'type' => 'string', + 'example' => 'eq', + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '查询分派策略信息', + 'summary' => '调用DescribeDispatchRule接口查询分派策略信息。', + 'description' => '当前接口已不再维护，请使用新版告警管理的ListNotificationPolicies接口查询通知策略信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'ListDispatchRule' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'Name', + 'in' => 'query', + 'schema' => [ + 'description' => '通知策略的名称， 支持模糊匹配。', + 'type' => 'string', + 'required' => false, + 'docRequired' => false, + 'example' => 'Prod', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'System', + 'in' => 'query', + 'schema' => [ + 'description' => '- `false`（默认）：通知策略为内部系统创建。'."\n" + .'- `true`：通知策略为外部系统创建。'."\n" + .'> 外部系统创建的通知策略不支持在ARMS控制台修改通知策略的分派条件。', + 'type' => 'boolean', + 'required' => false, + 'example' => 'true', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'description' => '请求ID。'."\n" + ."\n", + 'type' => 'string', + 'example' => '34ED024E-9E31-434A-9E4E-D9D15C3**** ', + ], + 'DispatchRules' => [ + 'description' => '返回结构体。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Name' => [ + 'description' => '通知策略的名称。', + 'type' => 'string', + 'example' => 'Prod', + ], + 'State' => [ + 'description' => '通知策略的启用状态。'."\n" + ."\n" + .'- `true`：启用。'."\n" + .'- `false`：关闭。', + 'type' => 'string', + 'example' => 'true', + ], + 'RuleId' => [ + 'description' => '通知策略ID。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10282', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '获取调度规则列表', + 'summary' => '调用ListDispatchRule接口查询通知策略列表。', + 'description' => '当前接口已不再维护，请使用新版告警管理的ListNotificationPolicies接口查询通知策略信息。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OpenArmsServiceSecondVersion' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + [ + 'APP' => [], + ], + [ + 'PrivateKey' => [], + ], + [ + 'BearerToken' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Type', + 'in' => 'query', + 'schema' => [ + 'description' => '服务类型：'."\n" + ."\n" + .'- `arms`：ARMS'."\n" + .'- `arms_app`：应用监控'."\n" + .'- `arms_web`：前端监控'."\n" + .'- `prometheus_monitor`：Prometheus监控'."\n" + .'- `synthetic_post`：云拨测', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'arms', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'OrderId' => [ + 'description' => '开通成功后返回的服务ID。', + 'type' => 'string', + 'example' => '20896874992****', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '9ED50893-F3C4-42DF-ABB2-C200BE******', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'INSUFFICIENT_AVAILABLE_QUOTA', + 'errorMessage' => '用户可用余额小于0，请充值后再次尝试开通。', + ], + ], + ], + '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' => '开通ARMS', + 'summary' => '开通ARMS下指定子产品的后付费功能。', + 'description' => '**OpenArmsServiceSecondVersion**接口支持开通以下产品版本：'."\n" + ."\n" + .'- 应用监控：基础版'."\n" + .'- 前端监控：基础版'."\n" + .'- 云拨测：专家版（按量付费）'."\n" + .'- Prometheus监控：专家版', + ], + 'OpenXtraceDefaultSLR' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '53CACA70-2CF7-490C-BD06-1A2AE4EB****', + ], + ], + ], + ], + ], + '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' => '开通可观测链路 OpenTelemetry 版服务关联角色', + 'summary' => '开通可观测链路 OpenTelemetry 版服务关联角色AliyunServiceRoleForXtrace。', + 'requestParamsDescription' => ' ', + 'responseParamsDescription' => ' ', + 'extraInfo' => ' ', + ], + 'OpenArmsDefaultSLR' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Data' => [ + 'description' => '操作是否成功。取值：'."\n" + ."\n" + .'- `true`：成功。'."\n" + .'- `false`：失败。', + 'type' => 'string', + 'example' => 'true', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '53CACA70-2CF7-490C-BD06-1A2AE4EB****', + ], + ], + ], + ], + ], + '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' => '开通ARMS服务关联角色', + 'summary' => '开通ARMS服务关联角色AliyunServiceRoleForARMS。', + ], + 'ChangeResourceGroup' => [ + 'summary' => '修改资源所属资源组。', + 'methods' => [ + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '资源的地域ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'schema' => [ + 'description' => '需要更换资源组的ARMS资源的ID。', + 'type' => 'string', + 'required' => true, + 'example' => 'ggxw4lnjuz@cfd34a78f******', + ], + ], + [ + 'name' => 'NewResourceGroupId', + 'in' => 'query', + 'schema' => [ + 'description' => '新的资源组ID，您可以在资源组控制台查看可用资源组。', + 'type' => 'string', + 'required' => true, + 'example' => 'rg-aek2vezare****', + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改资源组的ARMS资源类型。', + 'type' => 'string', + 'required' => false, + 'example' => 'APPLICATION', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '46355DD8-FC56-40C5-BFC6-269DE4F9****', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'ResourceId' => [ + 'description' => '资源ID。', + 'type' => 'string', + 'example' => 'ggxw4lnjuz@cfd34a78f******', + ], + 'ResourceGroupId' => [ + 'description' => '资源组 ID。', + 'type' => 'string', + 'example' => 'rg-aek2vezare****', + ], + ], + ], + 'Code' => [ + 'description' => '接口状态或pop错误码。', + 'type' => 'string', + 'example' => '200', + ], + 'Message' => [ + 'description' => '返回结果的提示信息。', + 'type' => 'string', + 'example' => 'message', + ], + ], + ], + ], + ], + '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' => 'ARMS资源转组', + ], + 'TagResources' => [ + 'summary' => '用于给ARMS资源实例打标签。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用的PID或实例ID，最多填写50个。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'uxqcr8b***', + ], + 'required' => true, + 'maxItems' => 50, + 'minItems' => 1, + ], + ], + [ + 'name' => 'Tag', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签列表，最多20个。', + 'type' => 'array', + 'items' => [ + 'description' => '标签。', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Key1', + ], + 'Value' => [ + 'description' => '标签值。', + 'type' => 'string', + 'required' => false, + 'example' => 'Test1', + ], + ], + 'required' => false, + ], + 'required' => true, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改标签的ARMS资源类型。'."\n" + ."\n" + .'- WEB-前端监控'."\n" + .'- APPLICATION-应用监控'."\n" + .'- PROMETHEUS-可观测监控 Prometheus 版'."\n" + .'- SYNTHETICTASK-云拨测'."\n" + .'- ALERTRULE-应用监控告警'."\n" + .'- PROMETHEUSALERTRULE-可观测监控 Prometheus 版告警'."\n" + .'- XTRACEAPP - 可观测链路 OpenTelemetry 版应用', + 'type' => 'string', + 'required' => true, + 'example' => 'APPLICATION', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '05919CF2-B8A1-588D-B3DB-89B3********', + ], + 'Data' => [ + 'description' => '是否创建成功。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'DuplicateTagKey', + 'errorMessage' => 'Param tagKey is duplicate.', + ], + [ + 'errorCode' => 'NoPermissionKeyOperator', + 'errorMessage' => 'user is no permission for operating param tagKey.', + ], + [ + 'errorCode' => 'ResourceIdAndTagIsNull', + 'errorMessage' => 'resourceId or tag param must have one', + ], + [ + 'errorCode' => 'TagISNull', + 'errorMessage' => 'param tag must be not null.', + ], + [ + 'errorCode' => 'TagNumOUT', + 'errorMessage' => 'the number of tag is out .', + ], + [ + 'errorCode' => 'ResourceIdIsNull', + 'errorMessage' => 'param resourceId must be not null.', + ], + [ + 'errorCode' => 'ResourceTypeIllegal', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'NoPermissionUSER', + 'errorMessage' => 'user no permission', + ], + [ + 'errorCode' => 'ScopeDisAgreement', + 'errorMessage' => 'Param scope is different from before.', + ], + [ + 'errorCode' => 'ParameterNextTokenIllegal', + 'errorMessage' => 'param nextToken is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterTagKey', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterTagValue', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + [ + 'errorCode' => 'TagKeyIsIllegal', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'TagValueIsIllegal', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + [ + 'errorCode' => 'ResourceIDOUT', + 'errorMessage' => 'The specified resourceId number is out of range.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"05919CF2-B8A1-588D-B3DB-89B3********\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '创建标签资源关系', + ], + 'UntagResources' => [ + 'summary' => '用于删除ARMS资源实例标签。', + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'update', + ], + 'parameters' => [ + [ + 'name' => 'TagKey', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '需要删除的标签键列表，不超过20个。不填可通过**All**参数删除所有标签。', + 'type' => 'array', + 'items' => [ + 'description' => '标签键。', + 'type' => 'string', + 'required' => false, + 'example' => 'Key1', + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + [ + 'name' => 'ResourceId', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '应用的PID或实例ID，最多50个。', + 'type' => 'array', + 'items' => [ + 'description' => '实例ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'c7c13c449eea64fe89870ac658d******', + ], + 'required' => true, + 'maxItems' => 51, + ], + ], + [ + 'name' => 'ResourceType', + 'in' => 'query', + 'schema' => [ + 'description' => '需要修改标签的ARMS资源类型。 '."\n" + ."\n" + .'- WEB-前端监控 '."\n" + .'- APPLICATION-应用监控 '."\n" + .'- PROMETHEUS-可观测监控 Prometheus 版 '."\n" + .'- SYNTHETICTASK-云拨测 '."\n" + .'- ALERTRULE-应用监控告警 '."\n" + .'- PROMETHEUSALERTRULE-可观测监控 Prometheus 版告警'."\n" + .'- XTRACEAPP - 可观测链路 OpenTelemetry 版应用', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [], + 'example' => 'APPLICATION', + ], + ], + [ + 'name' => 'All', + 'in' => 'query', + 'schema' => [ + 'description' => '是否全部删除，只针对TagKey.N为空时有效。取值范围：'."\n" + ."\n" + .'- true：全部删除'."\n" + .'- false（默认）：不全部删除', + 'type' => 'boolean', + 'required' => false, + 'example' => 'false', + ], + ], + [ + 'name' => 'Tags', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '标签键值对，当您未输入ResourceIds参数时必填。取值说明如下： '."\n" + ."\n" + .'- key：标签键，字符长度范围[1,128]。 '."\n" + .'- value：标签值，字符长度范围[1,128]。 '."\n" + .' '."\n" + .'区分大小写。如果指定多个标签，则会为指定资源同时创建并绑定多个标签。同一个资源上的同一个标签键只能对应一个标签值。如果您尝试添加已有标签键，则对应的标签值会更新为新值。不能以`aliyun`和`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '标签键。必填参数，不允许为空字符串。最多支持128个字符，不能以`aliyun`和`acs:`开头，不能包含`http://`或 `https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestTag', + ], + 'Value' => [ + 'description' => '实例的标签值。'."\n" + ."\n" + .'如果传入该值，则允许为空字符串。最多支持128个字符，不能以`acs:`开头，不能包含`http://`或者`https://`。', + 'type' => 'string', + 'required' => false, + 'example' => 'TestValue', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 21, + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => 'Schema of Response', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => 'FC183B5E-C9AD-5E9E-937F-*******', + ], + 'Data' => [ + 'description' => '是否删除成功。', + 'type' => 'string', + 'example' => 'success', + ], + ], + ], + ], + ], + 'errorCodes' => [ + 400 => [ + [ + 'errorCode' => 'NoPermissionKeyOperator', + 'errorMessage' => 'user is no permission for operating param tagKey.', + ], + [ + 'errorCode' => 'DuplicateTagKey', + 'errorMessage' => 'Param tagKey is duplicate.', + ], + [ + 'errorCode' => 'NoPermissionUSER', + 'errorMessage' => 'user no permission', + ], + [ + 'errorCode' => 'ResourceIdAndTagIsNull', + 'errorMessage' => 'resourceId or tag param must have one', + ], + [ + 'errorCode' => 'TagISNull', + 'errorMessage' => 'param tag must be not null.', + ], + [ + 'errorCode' => 'ScopeDisAgreement', + 'errorMessage' => 'Param scope is different from before.', + ], + [ + 'errorCode' => 'ParameterNextTokenIllegal', + 'errorMessage' => 'param nextToken is invalid.', + ], + [ + 'errorCode' => 'TagNumOUT', + 'errorMessage' => 'the number of tag is out .', + ], + [ + 'errorCode' => 'ResourceTypeIllegal', + 'errorMessage' => 'The ResourceType parameter is invalid.', + ], + [ + 'errorCode' => 'ResourceIdIsNull', + 'errorMessage' => 'param resourceId must be not null.', + ], + [ + 'errorCode' => 'InvalidParameterTagKey', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'InvalidParameterTagValue', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + [ + 'errorCode' => 'TagKeyIsIllegal', + 'errorMessage' => 'The specified TagKey is invalid.', + ], + [ + 'errorCode' => 'TagValueIsIllegal', + 'errorMessage' => 'The specified TagValue is invalid.', + ], + [ + 'errorCode' => 'ResourceIDOUT', + 'errorMessage' => 'The specified resourceId number is out of range.', + ], + ], + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"FC183B5E-C9AD-5E9E-937F-*******\\",\\n \\"Data\\": \\"success\\"\\n}","type":"json"}]', + 'title' => '删除标签资源关系', + ], + 'GetCommercialStatus' => [ + 'summary' => '查看当前账号是否开通对应产品的商业化版本。', + 'methods' => [ + 'get', + 'post', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。例如cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'CommodityCode', + 'in' => 'query', + 'schema' => [ + 'description' => '商品Code：'."\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', + 'type' => 'string', + 'required' => true, + 'example' => 'arms_app_post', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'title' => 'Schema of Response', + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '49C82193-E991-5F6A-AF3E-1664D8******', + ], + 'UserAndCommodityStatus' => [ + 'description' => '用户商业化状态。', + 'type' => 'object', + 'properties' => [ + 'Status' => [ + 'description' => '商业化状态。', + 'type' => 'string', + 'enumValueTitles' => [ + 'Normal' => '已开通', + 'Abnormal' => '开通异常', + 'Free' => '未开通', + ], + 'example' => 'Normal', + ], + 'FreeDays' => [ + 'description' => '试用期用户免费天数。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '10', + ], + 'Basic' => [ + 'description' => '是否为基础版用户。', + 'type' => 'boolean', + 'example' => 'false', + ], + 'ChargeType' => [ + 'description' => '付费类型。', + 'type' => 'string', + 'example' => 'usage', + ], + 'Lable' => [ + 'description' => '标签。', + 'type' => 'string', + 'example' => 'NEW', + ], + 'ExtraInfo' => [ + 'description' => '额外信息。', + 'type' => 'object', + 'example' => 'info', + ], + 'Enable' => [ + 'description' => '是否开通。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取商业化状态', + ], + 'CheckCommercialStatus' => [ + 'summary' => '检查产品的商业化开通状态。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'none', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。默认为cn-hangzhou。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + [ + 'name' => 'Service', + 'in' => 'query', + 'schema' => [ + 'description' => '子产品类型：'."\n" + ."\n" + .'- apm：应用监控'."\n" + .'- rum：用户体验监控'."\n" + .'- prometheus：可观测监控 Prometheus 版'."\n" + .'- xtrace：可观测链路 OpenTelemetry 版', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'xtrace' => 'xtrace', + 'prometheus' => 'prometheus', + 'rum' => 'rum', + 'apm' => 'apm', + ], + 'example' => 'apm', + ], + ], + ], + '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' => '1A474FF8-7861-4D00-81B5-5BC3DA4E****', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'string', + 'example' => 'True', + ], + ], + ], + ], + ], + 'staticInfo' => [ + 'returnType' => 'synchronous', + ], + 'responseDemo' => '[{"errorExample":"","example":"{\\n \\"RequestId\\": \\"1A474FF8-7861-4D00-81B5-5BC3DA4E****\\",\\n \\"Data\\": \\"True\\"\\n}","type":"json"}]', + 'title' => '检查产品商业化状态', + 'description' => '获取产品的商业化状态', + ], + 'QueryCommercialUsage' => [ + 'methods' => [ + 'post', + 'get', + ], + 'schemes' => [ + 'http', + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'readAndWrite', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + ], + 'parameters' => [ + [ + 'name' => 'IntervalInSec', + 'in' => 'query', + 'schema' => [ + 'description' => '数据片的时间间隔，单位为秒，最小值为3600。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => false, + 'docRequired' => true, + 'maximum' => '2147483647', + 'minimum' => '0', + 'enumValueTitles' => [ + 3600 => '小时', + 86400 => '天', + ], + 'example' => '3600', + 'default' => '2147483647', + ], + ], + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '起始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775806', + 'minimum' => '0', + 'example' => '1699200000000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'docRequired' => true, + 'maximum' => '9223372036854775806', + 'minimum' => '0', + 'example' => '1699286400000', + ], + ], + [ + 'name' => 'OrderBy', + 'in' => 'query', + 'schema' => [ + 'description' => '排序依据，可设为任一dimesion', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'dataType' => 'dataType', + ], + 'example' => 'dataType', + ], + ], + [ + 'name' => 'Metric', + 'in' => 'query', + 'schema' => [ + 'description' => '指标名称，取值：USAGEFEE.STAT', + 'type' => 'string', + 'required' => true, + 'docRequired' => true, + 'enumValueTitles' => [ + 'USAGEFEE.STAT' => 'USAGEFEE.STAT', + ], + 'example' => 'USAGEFEE.STAT'."\n", + ], + ], + [ + 'name' => 'Order', + 'in' => 'query', + 'schema' => [ + 'description' => '排序标准。取值：'."\n" + ."\n" + .'- `ASC`：升序。'."\n" + .'- `DESC`：降序。', + 'type' => 'string', + 'required' => false, + 'example' => 'ASC', + ], + ], + [ + 'name' => 'AdvancedFilters', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '过滤条件数组', + 'type' => 'array', + 'items' => [ + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '过滤条件的key', + 'type' => 'string', + 'required' => false, + 'example' => 'regionId', + ], + 'Value' => [ + 'description' => '过滤条件的value', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + 'OpType' => [ + 'description' => '操作符，目前仅支持等于或者in', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'in' => 'in', + 'eq' => 'eq', + ], + 'example' => 'eq', + ], + ], + 'required' => false, + ], + 'required' => false, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'Dimensions', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指标对应的维度。'."\n" + .'* dataType 数据类型'."\n" + .'* productType 产品类型'."\n" + .'* instanceId 实例ID'."\n" + .'* instanceName 实例名称'."\n" + .'* instanceType 实例类型', + 'type' => 'array', + 'items' => [ + 'description' => '指标对应的维度。', + 'type' => 'string', + 'required' => false, + 'example' => 'dataType', + ], + 'required' => false, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'Measures', + 'in' => 'query', + 'style' => 'repeatList', + 'schema' => [ + 'description' => '指标对应的测量数据。', + 'type' => 'array', + 'items' => [ + 'description' => '指标对应的测量数据。目前仅支持byte_sum', + 'type' => 'string', + 'required' => false, + 'enumValueTitles' => [ + 'byte_sum' => 'byte_sum', + ], + 'example' => 'byte_sum', + ], + 'required' => false, + 'maxItems' => 15, + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'title' => '', + 'description' => '查询的数据返回类型：'."\n" + .'* instantQuery 非时序'."\n" + .'* timeSeriesQuery 时序', + 'type' => 'string', + 'required' => true, + 'enumValueTitles' => [ + 'timeSeriesQuery' => 'timeSeriesQuery', + 'instantQuery' => 'instantQuery', + ], + 'example' => 'instantQuery', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'Code' => [ + 'description' => '接口状态，取值说明如下：2XX：成功。3XX：重定向。4XX：请求错误。5XX：服务器错误。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'HttpStatusCode' => [ + 'description' => 'HTTP状态码', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => 'success', + ], + 'RequestId' => [ + 'description' => '请求ID。', + 'type' => 'string', + 'example' => '99A663CB-8D7B-4B0D-A006-03C8EE38E7BB', + ], + 'Success' => [ + 'description' => '查询是否成功：'."\n" + ."\n" + .'- true：成功。'."\n" + .'- false：失败。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Complete' => [ + 'description' => '涉及到多区域查询是，整体是否执行完成：'."\n" + ."\n" + .'- **true**：是。'."\n" + ."\n" + .'- **false**：否。', + 'type' => 'boolean', + 'example' => 'true', + ], + 'Items' => [ + 'description' => '返回数据的数据结构体列表。', + 'type' => 'array', + 'items' => [ + 'description' => '数据项', + 'type' => 'object', + 'example' => '{'."\n" + .' "date": "1697108400",'."\n" + .' "dataType": "metrics",'."\n" + .' "byte_sum": 9497922'."\n" + .'}', + ], + ], + ], + ], + ], + ], + ], + ], + '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' => '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' => '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.', + ], + ], + 403 => [ + [ + 'errorCode' => 'APINotAuthorize', + 'errorMessage' => 'The current user is not authorized to access the interface.', + ], + ], + ], + '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' => '查询可观测用量数据', + 'summary' => '查询写入量数据，支持应用监控、可观测链路OpenTelemetry版、Prometheus、用户体验监控四大产品用量数据。', + 'extraInfo' => '* 调用时为什么会出现RAM的权限问题？ 这可能是由于该RAM角色没有权限，您可以为用户添加权限，请参见借助RAM角色实现跨云账号访问资源。'."\n" + .'* 怎么拉取列表数据（不考虑时间粒度）？ 将queryType设置为instantQuery'."\n" + .'* 返回时间非法，目前intervalInSec仅支持3600以及8600,不支持其他间隔', + ], + 'GetRumOcuStatisticData' => [ + 'summary' => '获取RUM的OCU用量数据。', + 'methods' => [ + 'get', + ], + 'schemes' => [ + 'https', + ], + 'security' => [ + [ + 'AK' => [], + ], + ], + 'operationType' => 'read', + 'deprecated' => false, + 'systemTags' => [ + 'operationType' => 'get', + 'riskType' => 'none', + 'chargeType' => 'free', + ], + 'parameters' => [ + [ + 'name' => 'StartTime', + 'in' => 'query', + 'schema' => [ + 'description' => '开始时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1600063200000', + ], + ], + [ + 'name' => 'EndTime', + 'in' => 'query', + 'schema' => [ + 'description' => '结束时间的时间戳，精确到毫秒。', + 'type' => 'integer', + 'format' => 'int64', + 'required' => true, + 'example' => '1687849260000', + ], + ], + [ + 'name' => 'QueryType', + 'in' => 'query', + 'schema' => [ + 'description' => '查询类型，非时序数据：INSTANT，时序数据：TIME_SERIES。', + 'type' => 'string', + 'required' => false, + 'example' => 'TIME_SERIES', + ], + ], + [ + 'name' => 'Filter', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '筛选条件，'."\n" + .'目前提供三种筛选条件：'."\n" + ."\n" + .'- 应用名称：pid（注意，展示应用名称，但是实际上传入的是应用id）'."\n" + .'- 应用类型：siteType'."\n" + .'- 数据类型：dataType', + 'type' => 'array', + 'items' => [ + 'description' => 'JSON Array，数组中元素的格式为：'."\n" + ."\n" + .'```'."\n" + .'{'."\n" + .'"Key":"pid",'."\n" + .'"OpType":"in",'."\n" + .'"Value":["xxx", "xxx"],'."\n" + .'}'."\n" + .'```', + 'type' => 'object', + 'properties' => [ + 'Key' => [ + 'description' => '过滤条件Key。目前提供三种筛选条件：'."\n" + .'- 应用名称：pid（注意，展示应用名称，但是实际上传入的是应用id）'."\n" + .'- 应用类型：siteType'."\n" + .'- 数据类型：dataType', + 'type' => 'string', + 'required' => false, + 'example' => 'pid', + ], + 'OpType' => [ + 'description' => '筛选类型，目前支持in（包含）。', + 'type' => 'string', + 'required' => false, + 'example' => 'in', + ], + 'Value' => [ + 'description' => '过滤的值，JSON Array类型的字符串，元素为字符串。', + 'type' => 'any', + 'required' => false, + 'example' => '["b590xxxxx@2dcbxxxxx9", "b590xxxxx@2dcbxxxxx8"]', + ], + ], + 'required' => false, + ], + 'required' => false, + ], + ], + [ + 'name' => 'Group', + 'in' => 'query', + 'style' => 'json', + 'schema' => [ + 'description' => '分组字段，支持传入：'."\n" + .'- siteType，按照应用类型分组统计总OCU'."\n" + .'- dataType，按照数据类型分组统计总OCU'."\n" + .'- pid，按照应用id分组统计OCU'."\n" + .'- appName，按照应用名分组统计OCU'."\n" + .'- startTime，按照开始时间分组统计OCU', + 'type' => 'array', + 'items' => [ + 'description' => '分组key。', + 'type' => 'string', + 'required' => false, + 'example' => '['."\n" + .' "siteType",'."\n" + .' "dataType"'."\n" + .']', + ], + 'required' => false, + ], + ], + [ + 'name' => 'Page', + 'in' => 'query', + 'schema' => [ + 'description' => '页码。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '1', + ], + ], + [ + 'name' => 'PageSize', + 'in' => 'query', + 'schema' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'required' => true, + 'example' => '100', + ], + ], + [ + 'name' => 'RegionId', + 'in' => 'query', + 'schema' => [ + 'description' => '地域ID。', + 'type' => 'string', + 'required' => false, + 'example' => 'cn-hangzhou', + ], + ], + ], + 'responses' => [ + 200 => [ + 'schema' => [ + 'type' => 'object', + 'properties' => [ + 'RequestId' => [ + 'title' => 'Id of the request', + 'description' => 'Id of the request', + 'type' => 'string', + 'example' => '626037F5-FDEB-45B0-804C-B3C92797****', + ], + 'Code' => [ + 'description' => '状态码。200表示成功。', + 'type' => 'integer', + 'format' => 'int64', + 'example' => '200', + ], + 'Message' => [ + 'description' => '调用失败时返回的信息。', + 'type' => 'string', + 'example' => '内部错误，请联系客户人员。', + ], + 'Data' => [ + 'description' => '返回结构体。', + 'type' => 'object', + 'properties' => [ + 'Items' => [ + 'description' => '查询到的数据列表。', + 'type' => 'array', + 'items' => [ + 'description' => '查询到的数据详情，JSON Map格式。', + 'type' => 'object', + 'additionalProperties' => [ + 'type' => 'any', + 'description' => '数据项', + 'example' => '{'."\n" + .' "totalChargedSessionCount": "11008",'."\n" + .' "__time__": 1717948800,'."\n" + .' "appName": "主控制台",'."\n" + .' "totalOcu": "55",'."\n" + .' "startTime": "1719244800",'."\n" + .' "pid": "b5xxxxxuqs@1f59cxxxxxxxxxb",'."\n" + .' "totalCount": "11"'."\n" + .'}', + ], + ], + ], + 'Total' => [ + 'description' => '数据总条数。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Page' => [ + 'description' => '当前页。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '1', + ], + 'PageSize' => [ + 'description' => '分页大小。', + 'type' => 'integer', + 'format' => 'int32', + 'example' => '100', + ], + 'Complete' => [ + 'description' => '是否还有下一页。', + 'type' => 'boolean', + 'example' => 'true', + ], + ], + ], + ], + ], + ], + ], + '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' => '获取RUM的OCU用量数据', + 'description' => '今天的用量可以随时获取，昨天的用量需要在今天8点后获取。', + ], + ], + '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', + ], + ], +]; |